Merge pull request #770 from GetStream/feat/hard-delete

feat(llc): added hard delete

packages/stream_chat/CHANGELOG.md

@@ -3,6 +3,7 @@
 ✅ Added
 
 - Extra properties added to `PaginationParams` to aid in fetching messages.
+- Added hard delete functionality.
 
 🐞 Fixed
 

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

@@ -648,7 +648,7 @@ class Channel {
   }
 
   /// Deletes the [message] from the channel.
-  Future<EmptyResponse> deleteMessage(Message message) async {
+  Future<EmptyResponse> deleteMessage(Message message, {bool? hard}) async {
     // Directly deleting the local messages which are not yet sent to server
     if (message.status == MessageSendingStatus.sending ||
         message.status == MessageSendingStatus.failed) {
@@ -675,7 +675,7 @@ class Channel {
 
       state?.addMessage(message);
 
-      final response = await _client.deleteMessage(message.id);
+      final response = await _client.deleteMessage(message.id, hard: hard);
 
       state?.addMessage(message.copyWith(status: MessageSendingStatus.sent));
 
@@ -1663,7 +1663,11 @@ class ChannelClientState {
   void _listenMessageDeleted() {
     _subscriptions.add(_channel.on(EventType.messageDeleted).listen((event) {
       final message = event.message!;
-      addMessage(message);
+      if (event.hardDelete == true) {
+        removeMessage(message, hardDelete: true);
+      } else {
+        addMessage(message);
+      }
     }));
   }
 
@@ -1718,7 +1722,7 @@ class ChannelClientState {
   }
 
   /// Remove a [message] from this [channelState].
-  void removeMessage(Message message) {
+  void removeMessage(Message message, {bool hardDelete = false}) {
     final parentId = message.parentId;
     // i.e. it's a thread message
     // 1. Remove the thread message
@@ -1740,7 +1744,10 @@ class ChannelClientState {
     } else {
       // Remove regular message
       final allMessages = [...messages];
-      if (allMessages.remove(message)) {
+      if (hardDelete) {
+        allMessages.removeWhere((e) => e.id == message.id);
+        _channelState = _channelState.copyWith(messages: allMessages);
+      } else if (allMessages.remove(message)) {
         _channelState = _channelState.copyWith(messages: allMessages);
       }
     }

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

@@ -1213,8 +1213,14 @@ class StreamChatClient {
       );
 
   /// Deletes the given message
-  Future<EmptyResponse> deleteMessage(String messageId) =>
-      _chatApi.message.deleteMessage(messageId);
+  Future<EmptyResponse> deleteMessage(String messageId, {bool? hard}) async {
+    final response =
+        await _chatApi.message.deleteMessage(messageId, hard: hard);
+    if (hard == true) {
+      await _chatPersistenceClient?.deleteMessageById(messageId);
+    }
+    return response;
+  }
 
   /// Get a message by [messageId]
   Future<GetMessageResponse> getMessage(String messageId) =>

packages/stream_chat/lib/src/core/api/message_api.dart

@@ -80,10 +80,16 @@ class MessageApi {
 
   /// Deletes the given [messageId]
   Future<EmptyResponse> deleteMessage(
-    String messageId,
-  ) async {
+    String messageId, {
+    bool? hard,
+  }) async {
     final response = await _client.delete(
       '/messages/$messageId',
+      queryParameters: hard != null
+          ? {
+              'hard': hard,
+            }
+          : null,
     );
     return EmptyResponse.fromJson(response.data);
   }

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

@@ -27,6 +27,7 @@ class Event {
     this.channelId,
     this.channelType,
     this.parentId,
+    this.hardDelete,
     this.extraData = const {},
     this.isLocal = true,
   }) : createdAt = createdAt?.toUtc() ?? DateTime.now().toUtc();
@@ -91,6 +92,10 @@ class Event {
   @JsonKey(defaultValue: false)
   final bool isLocal;
 
+  /// This is true if the message has been hard deleted
+  @JsonKey(includeIfNull: false)
+  final bool? hardDelete;
+
   /// Map of custom channel extraData
   final Map<String, Object?> extraData;
 
@@ -113,6 +118,7 @@ class Event {
     'channel_id',
     'channel_type',
     'parent_id',
+    'hard_delete',
     'is_local',
   ];
 
@@ -139,6 +145,7 @@ class Event {
     int? unreadChannels,
     bool? online,
     String? parentId,
+    bool? hardDelete,
     Map<String, Object?>? extraData,
   }) =>
       Event(
@@ -158,6 +165,7 @@ class Event {
         channelId: channelId ?? this.channelId,
         channelType: channelType ?? this.channelType,
         parentId: parentId ?? this.parentId,
+        hardDelete: hardDelete ?? this.hardDelete,
         extraData: extraData ?? this.extraData,
         isLocal: isLocal,
       );

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

@@ -37,30 +37,42 @@ Event _$EventFromJson(Map<String, dynamic> json) => Event(
       channelId: json['channel_id'] as String?,
       channelType: json['channel_type'] as String?,
       parentId: json['parent_id'] as String?,
+      hardDelete: json['hard_delete'] as bool?,
       extraData: json['extra_data'] as Map<String, dynamic>? ?? const {},
       isLocal: json['is_local'] as bool? ?? false,
     );
 
-Map<String, dynamic> _$EventToJson(Event instance) => <String, dynamic>{
-      'type': instance.type,
-      'cid': instance.cid,
-      'channel_id': instance.channelId,
-      'channel_type': instance.channelType,
-      'connection_id': instance.connectionId,
-      'created_at': instance.createdAt.toIso8601String(),
-      'me': instance.me?.toJson(),
-      'user': instance.user?.toJson(),
-      'message': instance.message?.toJson(),
-      'channel': instance.channel?.toJson(),
-      'member': instance.member?.toJson(),
-      'reaction': instance.reaction?.toJson(),
-      'total_unread_count': instance.totalUnreadCount,
-      'unread_channels': instance.unreadChannels,
-      'online': instance.online,
-      'parent_id': instance.parentId,
-      'is_local': instance.isLocal,
-      'extra_data': instance.extraData,
-    };
+Map<String, dynamic> _$EventToJson(Event instance) {
+  final val = <String, dynamic>{
+    'type': instance.type,
+    'cid': instance.cid,
+    'channel_id': instance.channelId,
+    'channel_type': instance.channelType,
+    'connection_id': instance.connectionId,
+    'created_at': instance.createdAt.toIso8601String(),
+    'me': instance.me?.toJson(),
+    'user': instance.user?.toJson(),
+    'message': instance.message?.toJson(),
+    'channel': instance.channel?.toJson(),
+    'member': instance.member?.toJson(),
+    'reaction': instance.reaction?.toJson(),
+    'total_unread_count': instance.totalUnreadCount,
+    'unread_channels': instance.unreadChannels,
+    'online': instance.online,
+    'parent_id': instance.parentId,
+    'is_local': instance.isLocal,
+  };
+
+  void writeNotNull(String key, dynamic value) {
+    if (value != null) {
+      val[key] = value;
+    }
+  }
+
+  writeNotNull('hard_delete', instance.hardDelete);
+  val['extra_data'] = instance.extraData;
+  return val;
+}
 
 EventChannel _$EventChannelFromJson(Map<String, dynamic> json) => EventChannel(
       members: (json['members'] as List<dynamic>?)

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

@@ -8,7 +8,7 @@ part 'read.g.dart';
 @JsonSerializable()
 class Read extends Equatable {
   /// Constructor used for json serialization
-  Read({
+  const Read({
     required this.lastRead,
     required this.user,
     this.unreadMessages = 0,