feat: Add delivery receipts privacy setting

This commit introduces a new privacy setting to control delivery receipts.

- A `DeliveryReceipts` class is added to `privacy_settings.dart`, allowing users to enable or disable the sending of delivery receipt events.
- `PrivacySettings` is updated to include the new `deliveryReceipts` option.
- `OwnUser` now includes an `isDeliveryReceiptsEnabled` getter to easily check the user's current setting.
- Generated JSON serialization files have been updated accordingly.

Author: xsahil03x

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

@@ -1631,7 +1631,7 @@ class Channel {
   Future<EmptyResponse> markRead({String? messageId}) async {
     _checkInitialized();
 
-    if (!canReceiveReadEvents) {
+    if (!canUseReadReceipts) {
       throw const StreamChatError(
         'Cannot mark as read: Channel does not support read events. '
         'Enable read_events in your channel type configuration.',
@@ -1648,7 +1648,7 @@ class Channel {
   Future<EmptyResponse> markUnread(String messageId) async {
     _checkInitialized();
 
-    if (!canReceiveReadEvents) {
+    if (!canUseReadReceipts) {
       throw const StreamChatError(
         'Cannot mark as unread: Channel does not support read events. '
         'Enable read_events in your channel type configuration.',
@@ -1662,7 +1662,7 @@ class Channel {
   Future<EmptyResponse> markThreadRead(String threadId) async {
     _checkInitialized();
 
-    if (!canReceiveReadEvents) {
+    if (!canUseReadReceipts) {
       throw const StreamChatError(
         'Cannot mark thread as read: Channel does not support read events. '
         'Enable read_events in your channel type configuration.',
@@ -1676,7 +1676,7 @@ class Channel {
   Future<EmptyResponse> markThreadUnread(String threadId) async {
     _checkInitialized();
 
-    if (!canReceiveReadEvents) {
+    if (!canUseReadReceipts) {
       throw const StreamChatError(
         'Cannot mark thread as unread: Channel does not support read events. '
         'Enable read_events in your channel type configuration.',
@@ -2092,9 +2092,9 @@ class Channel {
   // privacy settings.
   bool get _canSendTypingEvents {
     final currentUser = client.state.currentUser;
-    final typingIndicatorsEnabled = currentUser?.isTypingIndicatorsEnabled;
+    if (currentUser == null) return false;
 
-    return canUseTypingEvents && (typingIndicatorsEnabled ?? true);
+    return canUseTypingEvents && currentUser.isTypingIndicatorsEnabled;
   }
 
   /// Sends the [Event.typingStart] event and schedules a timer to invoke the
@@ -3501,14 +3501,11 @@ class ChannelClientState {
             final user = event.user;
             if (user == null) return;
 
-            final currentUser = _channel.client.state.currentUser;
-            if (currentUser == null) return;
+            final currentUser = _client.state.currentUser;
+            if (event.isFromUser(userId: currentUser?.id)) return;
 
-            if (user.id != currentUser.id) {
-              final events = {...typingEvents};
-              events[user] = event;
-              _typingEventsController.safeAdd(events);
-            }
+            final events = {...typingEvents, user: event};
+            _typingEventsController.safeAdd(events);
           },
         ),
       )
@@ -3518,13 +3515,11 @@ class ChannelClientState {
             final user = event.user;
             if (user == null) return;
 
-            final currentUser = _channel.client.state.currentUser;
-            if (currentUser == null) return;
+            final currentUser = _client.state.currentUser;
+            if (event.isFromUser(userId: currentUser?.id)) return;
 
-            if (user.id != currentUser.id) {
-              final events = {...typingEvents}..remove(user);
-              _typingEventsController.safeAdd(events);
-            }
+            final events = {...typingEvents}..remove(user);
+            _typingEventsController.safeAdd(events);
           },
         ),
       );
@@ -3819,7 +3814,11 @@ extension ChannelCapabilityCheck on Channel {
   }
 
   /// True, if the current user has read events capability.
-  bool get canReceiveReadEvents {
+  @Deprecated('Use canUseReadReceipts instead')
+  bool get canReceiveReadEvents => canUseReadReceipts;
+
+  /// True, if the current user has read events capability.
+  bool get canUseReadReceipts {
     return ownCapabilities.contains(ChannelCapability.readEvents);
   }
 
@@ -3858,4 +3857,9 @@ extension ChannelCapabilityCheck on Channel {
   bool get canQueryPollVotes {
     return ownCapabilities.contains(ChannelCapability.queryPollVotes);
   }
+
+  /// True, if the current user has delivery events capability.
+  bool get canUseDeliveryReceipts {
+    return ownCapabilities.contains(ChannelCapability.deliveryEvents);
+  }
 }

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

@@ -2,7 +2,7 @@ import 'package:logging/logging.dart';
 import 'package:rate_limiter/rate_limiter.dart';
 import 'package:stream_chat/src/client/channel.dart';
 import 'package:stream_chat/src/core/models/message.dart';
-import 'package:stream_chat/src/core/models/message_delivery_info.dart';
+import 'package:stream_chat/src/core/models/message_delivery.dart';
 import 'package:stream_chat/src/core/util/message_rules.dart';
 import 'package:synchronized/synchronized.dart';
 
@@ -11,7 +11,7 @@ import 'package:synchronized/synchronized.dart';
 /// Each [MessageDeliveryInfo] represents an acknowledgment that the current
 /// user has received a message.
 typedef MarkChannelsDelivered = Future<void> Function(
-  Iterable<MessageDeliveryInfo> messages,
+  Iterable<MessageDelivery> deliveries,
 );
 
 /// Manages the delivery reporting for channel messages.
@@ -154,23 +154,23 @@ class ChannelDeliveryReporter {
   Future<void> _markCandidatesAsDelivered() async {
     // We only process at-most 100 channels at a time to avoid large payloads.
     final batch = {..._deliveryCandidates}.entries.take(_maxCandidatesPerBatch);
-    final messageInfoPayload = batch.map(
-      (it) => MessageDeliveryInfo(channelCid: it.key, messageId: it.value.id),
+    final messageDeliveries = batch.map(
+      (it) => MessageDelivery(channelCid: it.key, messageId: it.value.id),
     );
 
-    if (messageInfoPayload.isEmpty) return;
+    if (messageDeliveries.isEmpty) return;
 
-    _logger?.info('Marking ${messageInfoPayload.length} channels as delivered');
+    _logger?.info('Marking ${messageDeliveries.length} channels as delivered');
 
     try {
-      await onMarkChannelsDelivered(messageInfoPayload);
+      await onMarkChannelsDelivered(messageDeliveries);
 
       // Clear the successfully delivered candidates. If a channel's message ID
       // has changed since we started delivery, keep it for the next batch.
       await _deliveryCandidatesLock.synchronized(() {
-        for (final messageInfo in messageInfoPayload) {
-          final deliveredChannelCid = messageInfo.channelCid;
-          final deliveredMessageId = messageInfo.messageId;
+        for (final delivery in messageDeliveries) {
+          final deliveredChannelCid = delivery.channelCid;
+          final deliveredMessageId = delivery.messageId;
 
           final currentMessage = _deliveryCandidates[deliveredChannelCid];
           // Skip removal if a newer message has been added while we were

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

@@ -28,7 +28,7 @@ import 'package:stream_chat/src/core/models/event.dart';
 import 'package:stream_chat/src/core/models/filter.dart';
 import 'package:stream_chat/src/core/models/member.dart';
 import 'package:stream_chat/src/core/models/message.dart';
-import 'package:stream_chat/src/core/models/message_delivery_info.dart';
+import 'package:stream_chat/src/core/models/message_delivery.dart';
 import 'package:stream_chat/src/core/models/message_reminder.dart';
 import 'package:stream_chat/src/core/models/own_user.dart';
 import 'package:stream_chat/src/core/models/poll.dart';
@@ -1692,9 +1692,9 @@ class StreamChatClient {
   ///
   /// Accepts up to 100 channels per call.
   Future<EmptyResponse> markChannelsDelivered(
-    Iterable<MessageDeliveryInfo> messages,
+    Iterable<MessageDelivery> deliveries,
   ) {
-    return _chatApi.channel.markChannelsDelivered(messages);
+    return _chatApi.channel.markChannelsDelivered([...deliveries]);
   }
 
   /// Send an event to a particular channel

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

@@ -8,7 +8,7 @@ import 'package:stream_chat/src/core/models/channel_state.dart';
 import 'package:stream_chat/src/core/models/event.dart';
 import 'package:stream_chat/src/core/models/filter.dart';
 import 'package:stream_chat/src/core/models/message.dart';
-import 'package:stream_chat/src/core/models/message_delivery_info.dart';
+import 'package:stream_chat/src/core/models/message_delivery.dart';
 
 /// Defines the api dedicated to channel operations
 class ChannelApi {
@@ -398,11 +398,13 @@ class ChannelApi {
   ///
   /// Accepts up to 100 channels per call.
   Future<EmptyResponse> markChannelsDelivered(
-    Iterable<MessageDeliveryInfo> messages,
+    List<MessageDelivery> deliveries,
   ) async {
     final response = await _client.post(
       '/channels/delivered',
-      data: jsonEncode({'latest_delivered_messages': messages}),
+      data: jsonEncode({
+        'latest_delivered_messages': deliveries,
+      }),
     );
     return EmptyResponse.fromJson(response.data);
   }

packages/stream_chat/lib/src/core/models/message_delivery_info.dart renamed to packages/stream_chat/lib/src/core/models/message_delivery.dart

@@ -1,15 +1,15 @@
 import 'package:json_annotation/json_annotation.dart';
 
-part 'message_delivery_info.g.dart';
+part 'message_delivery.g.dart';
 
 /// A delivery receipt for a message in a channel.
 ///
 /// Used to acknowledge that the current user has received a message,
 /// notifying the sender that their message was delivered.
 @JsonSerializable(createFactory: false)
-class MessageDeliveryInfo {
+class MessageDelivery {
   /// Creates a delivery receipt for a message.
-  const MessageDeliveryInfo({
+  const MessageDelivery({
     required this.channelCid,
     required this.messageId,
   });
@@ -22,6 +22,6 @@ class MessageDeliveryInfo {
   @JsonKey(name: 'id')
   final String messageId;
 
-  /// Converts this [MessageDeliveryInfo] to JSON.
-  Map<String, dynamic> toJson() => _$MessageDeliveryInfoToJson(this);
+  /// Converts this [MessageDelivery] to JSON.
+  Map<String, dynamic> toJson() => _$MessageDeliveryToJson(this);
 }

packages/stream_chat/lib/src/core/models/message_delivery_info.g.dart renamed to packages/stream_chat/lib/src/core/models/message_delivery.g.dart

@@ -206,4 +206,12 @@ extension PrivacySettingsExtension on OwnUser {
 
     return readIndicators.enabled;
   }
+
+  /// Whether delivery receipts are enabled for the user.
+  bool get isDeliveryReceiptsEnabled {
+    final deliveryIndicators = privacySettings?.deliveryReceipts;
+    if (deliveryIndicators == null) return true;
+
+    return deliveryIndicators.enabled;
+  }
 }

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

@@ -10,6 +10,7 @@ class PrivacySettings extends Equatable {
   const PrivacySettings({
     this.typingIndicators,
     this.readReceipts,
+    this.deliveryReceipts,
   });
 
   /// Create a new instance from json.
@@ -23,11 +24,14 @@ class PrivacySettings extends Equatable {
   /// The settings for the read receipt events.
   final ReadReceipts? readReceipts;
 
+  /// The settings for the delivery receipt events.
+  final DeliveryReceipts? deliveryReceipts;
+
   /// Serialize to json.
   Map<String, dynamic> toJson() => _$PrivacySettingsToJson(this);
 
   @override
-  List<Object?> get props => [typingIndicators, readReceipts];
+  List<Object?> get props => [typingIndicators, readReceipts, deliveryReceipts];
 }
 
 /// The settings for typing indicator events.
@@ -80,3 +84,29 @@ class ReadReceipts extends Equatable {
   @override
   List<Object?> get props => [enabled];
 }
+
+/// The settings for the delivery receipt events.
+@JsonSerializable(includeIfNull: false)
+class DeliveryReceipts extends Equatable {
+  /// Create a new instance of [DeliveryReceipts].
+  const DeliveryReceipts({
+    this.enabled = true,
+  });
+
+  /// Create a new instance from json.
+  factory DeliveryReceipts.fromJson(Map<String, dynamic> json) {
+    return _$DeliveryReceiptsFromJson(json);
+  }
+
+  /// Whether the delivery receipt events are enabled for the user.
+  ///
+  /// If False, the user delivery events will not be sent to other users, along
+  /// with the user's delivery state.
+  final bool enabled;
+
+  /// Serialize to json.
+  Map<String, dynamic> toJson() => _$DeliveryReceiptsToJson(this);
+
+  @override
+  List<Object?> get props => [enabled];
+}