Add remoteId

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 3.1.3
+
+- Add `remoteId` message property
+
 ## 3.1.2
 
 - Additionally, revert `json_annotation` upgrade

lib/src/message.dart

@@ -23,6 +23,7 @@ abstract class Message extends Equatable {
     this.createdAt,
     this.id,
     this.metadata,
+    this.remoteId,
     this.roomId,
     this.status,
     this.type,
@@ -56,10 +57,11 @@ abstract class Message extends Equatable {
   /// [status] with null value will be overwritten by the previous status.
   /// [text] will be only set for the text message type. Null value will be
   /// overwritten by the previous text (can't be empty).
-  /// [updatedAt] with null value will nullify existing value.
+  /// [remoteId] and [updatedAt] with null value will nullify existing value.
   Message copyWith({
     Map<String, dynamic>? metadata,
     PreviewData? previewData,
+    String? remoteId,
     Status? status,
     String? text,
     int? updatedAt,
@@ -80,6 +82,9 @@ abstract class Message extends Equatable {
   /// Additional custom metadata or attributes related to the message
   final Map<String, dynamic>? metadata;
 
+  /// Unique ID of the message received from the backend
+  final String? remoteId;
+
   /// ID of the room where this message is sent
   final String? roomId;
 

lib/src/messages/custom_message.dart

@@ -18,6 +18,7 @@ class CustomMessage extends Message {
     int? createdAt,
     required String id,
     Map<String, dynamic>? metadata,
+    String? remoteId,
     String? roomId,
     Status? status,
     MessageType? type,
@@ -27,6 +28,7 @@ class CustomMessage extends Message {
           createdAt,
           id,
           metadata,
+          remoteId,
           roomId,
           status,
           type ?? MessageType.custom,
@@ -39,6 +41,7 @@ class CustomMessage extends Message {
     int? createdAt,
     required String id,
     required PartialCustom partialCustom,
+    String? remoteId,
     String? roomId,
     Status? status,
     int? updatedAt,
@@ -47,6 +50,7 @@ class CustomMessage extends Message {
           createdAt,
           id,
           partialCustom.metadata,
+          remoteId,
           roomId,
           status,
           MessageType.custom,
@@ -69,11 +73,12 @@ class CustomMessage extends Message {
   /// [previewData] is ignored for this message type.
   /// [status] with null value will be overwritten by the previous status.
   /// [text] is ignored for this message type.
-  /// [updatedAt] with null value will nullify existing value.
+  /// [remoteId] and [updatedAt] with null value will nullify existing value.
   @override
   Message copyWith({
     Map<String, dynamic>? metadata,
     PreviewData? previewData,
+    String? remoteId,
     Status? status,
     String? text,
     int? updatedAt,
@@ -88,6 +93,7 @@ class CustomMessage extends Message {
               ...this.metadata ?? {},
               ...metadata,
             },
+      remoteId: remoteId,
       roomId: roomId,
       status: status ?? this.status,
       updatedAt: updatedAt,

lib/src/messages/file_message.dart

@@ -19,6 +19,7 @@ class FileMessage extends Message {
     Map<String, dynamic>? metadata,
     this.mimeType,
     required this.name,
+    String? remoteId,
     String? roomId,
     required this.size,
     Status? status,
@@ -30,6 +31,7 @@ class FileMessage extends Message {
           createdAt,
           id,
           metadata,
+          remoteId,
           roomId,
           status,
           type ?? MessageType.file,
@@ -42,6 +44,7 @@ class FileMessage extends Message {
     int? createdAt,
     required String id,
     required PartialFile partialFile,
+    String? remoteId,
     String? roomId,
     Status? status,
     int? updatedAt,
@@ -54,6 +57,7 @@ class FileMessage extends Message {
           createdAt,
           id,
           partialFile.metadata,
+          remoteId,
           roomId,
           status,
           MessageType.file,
@@ -75,11 +79,12 @@ class FileMessage extends Message {
   /// [previewData] is ignored for this message type.
   /// [status] with null value will be overwritten by the previous status.
   /// [text] is ignored for this message type.
-  /// [updatedAt] with null value will nullify existing value.
+  /// [remoteId] and [updatedAt] with null value will nullify existing value.
   @override
   Message copyWith({
     Map<String, dynamic>? metadata,
     PreviewData? previewData,
+    String? remoteId,
     Status? status,
     String? text,
     int? updatedAt,
@@ -96,6 +101,7 @@ class FileMessage extends Message {
             },
       mimeType: mimeType,
       name: name,
+      remoteId: remoteId,
       roomId: roomId,
       size: size,
       status: status ?? this.status,

lib/src/messages/image_message.dart

@@ -19,6 +19,7 @@ class ImageMessage extends Message {
     required String id,
     Map<String, dynamic>? metadata,
     required this.name,
+    String? remoteId,
     String? roomId,
     required this.size,
     Status? status,
@@ -31,6 +32,7 @@ class ImageMessage extends Message {
           createdAt,
           id,
           metadata,
+          remoteId,
           roomId,
           status,
           type ?? MessageType.image,
@@ -43,6 +45,7 @@ class ImageMessage extends Message {
     int? createdAt,
     required String id,
     required PartialImage partialImage,
+    String? remoteId,
     String? roomId,
     Status? status,
     int? updatedAt,
@@ -56,6 +59,7 @@ class ImageMessage extends Message {
           createdAt,
           id,
           partialImage.metadata,
+          remoteId,
           roomId,
           status,
           MessageType.image,
@@ -77,11 +81,12 @@ class ImageMessage extends Message {
   /// [previewData] is ignored for this message type.
   /// [status] with null value will be overwritten by the previous status.
   /// [text] is ignored for this message type.
-  /// [updatedAt] with null value will nullify existing value.
+  /// [remoteId] and [updatedAt] with null value will nullify existing value.
   @override
   Message copyWith({
     Map<String, dynamic>? metadata,
     PreviewData? previewData,
+    String? remoteId,
     Status? status,
     String? text,
     int? updatedAt,
@@ -98,6 +103,7 @@ class ImageMessage extends Message {
               ...this.metadata ?? {},
               ...metadata,
             },
+      remoteId: remoteId,
       roomId: roomId,
       size: size,
       status: status ?? this.status,

lib/src/messages/text_message.dart

@@ -18,6 +18,7 @@ class TextMessage extends Message {
     required String id,
     Map<String, dynamic>? metadata,
     this.previewData,
+    String? remoteId,
     String? roomId,
     Status? status,
     required this.text,
@@ -28,6 +29,7 @@ class TextMessage extends Message {
           createdAt,
           id,
           metadata,
+          remoteId,
           roomId,
           status,
           type ?? MessageType.text,
@@ -40,6 +42,7 @@ class TextMessage extends Message {
     int? createdAt,
     required String id,
     required PartialText partialText,
+    String? remoteId,
     String? roomId,
     Status? status,
     int? updatedAt,
@@ -50,6 +53,7 @@ class TextMessage extends Message {
           createdAt,
           id,
           partialText.metadata,
+          remoteId,
           roomId,
           status,
           MessageType.text,
@@ -69,11 +73,12 @@ class TextMessage extends Message {
   /// both metadatas will be merged into one Map, where keys from a passed
   /// metadata will overwite keys from the previous one.
   /// [status] with null value will be overwritten by the previous status.
-  /// [updatedAt] with null value will nullify existing value.
+  /// [remoteId] and [updatedAt] with null value will nullify existing value.
   @override
   Message copyWith({
     Map<String, dynamic>? metadata,
     PreviewData? previewData,
+    String? remoteId,
     Status? status,
     String? text,
     int? updatedAt,
@@ -89,6 +94,7 @@ class TextMessage extends Message {
               ...metadata,
             },
       previewData: previewData,
+      remoteId: remoteId,
       roomId: roomId,
       status: status ?? this.status,
       text: text ?? this.text,

lib/src/messages/unsupported_message.dart

@@ -19,6 +19,7 @@ class UnsupportedMessage extends Message {
     int? createdAt,
     required String id,
     Map<String, dynamic>? metadata,
+    String? remoteId,
     String? roomId,
     Status? status,
     MessageType? type,
@@ -28,6 +29,7 @@ class UnsupportedMessage extends Message {
           createdAt,
           id,
           metadata,
+          remoteId,
           roomId,
           status,
           type ?? MessageType.unsupported,
@@ -50,11 +52,12 @@ class UnsupportedMessage extends Message {
   /// [previewData] is ignored for this message type.
   /// [status] with null value will be overwritten by the previous status.
   /// [text] is ignored for this message type.
-  /// [updatedAt] with null value will nullify existing value.
+  /// [remoteId] and [updatedAt] with null value will nullify existing value.
   @override
   Message copyWith({
     Map<String, dynamic>? metadata,
     PreviewData? previewData,
+    String? remoteId,
     Status? status,
     String? text,
     int? updatedAt,
@@ -69,6 +72,7 @@ class UnsupportedMessage extends Message {
               ...this.metadata ?? {},
               ...metadata,
             },
+      remoteId: remoteId,
       roomId: roomId,
       status: status ?? this.status,
       updatedAt: updatedAt,

pubspec.yaml

@@ -2,7 +2,7 @@ name: flutter_chat_types
 description: >
   Utility library for the flutter_chat_ui and flutter_firebase_chat_core libraries
   which contains shared type declarations.
-version: 3.1.2
+version: 3.1.3
 homepage: https://flyer.chat
 repository: https://github.com/flyerhq/flutter_chat_types