feat(llc): Add user-level privacy settings (#2430)

Author: xsahil03x

packages/stream_chat/CHANGELOG.md

@@ -1,3 +1,20 @@
+## Upcoming
+
+✅ Added
+
+- Added support for user-level privacy settings via `OwnUser.privacySettings`.
+- Added `invisible` field to `User` and `OwnUser` models.
+
+⚠️ Deprecated
+
+- Deprecated `Channel.canSendTypingEvents` in favor of `Channel.canUseTypingEvents`.
+
+🔄 Changed
+
+- Typing and read receipts now respect both channel capabilities and user privacy settings.
+- `markRead`, `markUnread`, `markThreadRead`, and `markThreadUnread` methods now throw
+  `StreamChatError` when channel lacks required capabilities.
+
 ## 9.19.0
 
 - Minor bug fixes and improvements

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

@@ -1641,6 +1641,14 @@ class Channel {
   /// read from a particular message onwards.
   Future<EmptyResponse> markRead({String? messageId}) async {
     _checkInitialized();
+
+    if (!canReceiveReadEvents) {
+      throw const StreamChatError(
+        'Cannot mark as read: Channel does not support read events. '
+        'Enable read_events in your channel type configuration.',
+      );
+    }
+
     return _client.markChannelRead(id!, type, messageId: messageId);
   }
 
@@ -1650,19 +1658,43 @@ class Channel {
   /// to be marked as unread.
   Future<EmptyResponse> markUnread(String messageId) async {
     _checkInitialized();
+
+    if (!canReceiveReadEvents) {
+      throw const StreamChatError(
+        'Cannot mark as unread: Channel does not support read events. '
+        'Enable read_events in your channel type configuration.',
+      );
+    }
+
     return _client.markChannelUnread(id!, type, messageId);
   }
 
   /// Mark the thread with [threadId] in the channel as read.
-  Future<EmptyResponse> markThreadRead(String threadId) {
+  Future<EmptyResponse> markThreadRead(String threadId) async {
     _checkInitialized();
-    return client.markThreadRead(id!, type, threadId);
+
+    if (!canReceiveReadEvents) {
+      throw const StreamChatError(
+        'Cannot mark thread as read: Channel does not support read events. '
+        'Enable read_events in your channel type configuration.',
+      );
+    }
+
+    return _client.markThreadRead(id!, type, threadId);
   }
 
   /// Mark the thread with [threadId] in the channel as unread.
-  Future<EmptyResponse> markThreadUnread(String threadId) {
+  Future<EmptyResponse> markThreadUnread(String threadId) async {
     _checkInitialized();
-    return client.markThreadUnread(id!, type, threadId);
+
+    if (!canReceiveReadEvents) {
+      throw const StreamChatError(
+        'Cannot mark thread as unread: Channel does not support read events. '
+        'Enable read_events in your channel type configuration.',
+      );
+    }
+
+    return _client.markThreadUnread(id!, type, threadId);
   }
 
   void _initState(ChannelState channelState) {
@@ -2066,20 +2098,29 @@ class Channel {
     onStopTyping: stopTyping,
   );
 
+  // Whether sending typing events is allowed in the channel and by the user
+  // privacy settings.
+  bool get _canSendTypingEvents {
+    final currentUser = client.state.currentUser;
+    final typingIndicatorsEnabled = currentUser?.isTypingIndicatorsEnabled;
+
+    return canUseTypingEvents && (typingIndicatorsEnabled ?? true);
+  }
+
   /// Sends the [Event.typingStart] event and schedules a timer to invoke the
   /// [Event.typingStop] event.
   ///
   /// This is meant to be called every time the user presses a key.
   Future<void> keyStroke([String? parentId]) async {
-    if (config?.typingEvents == false) return;
+    if (!_canSendTypingEvents) return;
 
     client.logger.info('KeyStroke received');
     return _keyStrokeHandler(parentId);
   }
 
   /// Sends the [EventType.typingStart] event.
   Future<void> startTyping([String? parentId]) async {
-    if (config?.typingEvents == false) return;
+    if (!_canSendTypingEvents) return;
 
     client.logger.info('start typing');
     await sendEvent(Event(
@@ -2090,7 +2131,7 @@ class Channel {
 
   /// Sends the [EventType.typingStop] event.
   Future<void> stopTyping([String? parentId]) async {
-    if (config?.typingEvents == false) return;
+    if (!_canSendTypingEvents) return;
 
     client.logger.info('stop typing');
     await sendEvent(Event(
@@ -3091,8 +3132,6 @@ class ChannelClientState {
   }
 
   void _listenReadEvents() {
-    if (_channelState.channel?.config.readEvents == false) return;
-
     _subscriptions
       ..add(
         _channel
@@ -3489,17 +3528,17 @@ class ChannelClientState {
   final _typingEventsController = BehaviorSubject.seeded(<User, Event>{});
 
   void _listenTypingEvents() {
-    if (_channelState.channel?.config.typingEvents == false) return;
-
-    final currentUser = _channel.client.state.currentUser;
-    if (currentUser == null) return;
-
     _subscriptions
       ..add(
         _channel.on(EventType.typingStart).listen(
           (event) {
             final user = event.user;
-            if (user != null && user.id != currentUser.id) {
+            if (user == null) return;
+
+            final currentUser = _channel.client.state.currentUser;
+            if (currentUser == null) return;
+
+            if (user.id != currentUser.id) {
               final events = {...typingEvents};
               events[user] = event;
               _typingEventsController.safeAdd(events);
@@ -3511,7 +3550,12 @@ class ChannelClientState {
         _channel.on(EventType.typingStop).listen(
           (event) {
             final user = event.user;
-            if (user != null && user.id != currentUser.id) {
+            if (user == null) return;
+
+            final currentUser = _channel.client.state.currentUser;
+            if (currentUser == null) return;
+
+            if (user.id != currentUser.id) {
               final events = {...typingEvents}..remove(user);
               _typingEventsController.safeAdd(events);
             }
@@ -3526,8 +3570,6 @@ class ChannelClientState {
   // the sender due to technical difficulties. e.g. process death, loss of
   // Internet connection or custom implementation.
   void _startCleaningStaleTypingEvents() {
-    if (_channelState.channel?.config.typingEvents == false) return;
-
     _staleTypingEventsCleanerTimer = Timer.periodic(
       const Duration(seconds: 1),
       (_) {
@@ -3703,7 +3745,9 @@ extension ChannelCapabilityCheck on Channel {
   }
 
   /// True, if the current user can send typing events.
+  @Deprecated('Use canUseTypingEvents instead')
   bool get canSendTypingEvents {
+    if (canUseTypingEvents) return true;
     return ownCapabilities.contains(ChannelCapability.sendTypingEvents);
   }
 

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

@@ -2223,7 +2223,6 @@ class ClientState {
             totalUnreadCount: currentUser?.totalUnreadCount,
             unreadChannels: currentUser?.unreadChannels,
             unreadThreads: currentUser?.unreadThreads,
-            blockedUserIds: currentUser?.blockedUserIds,
             pushPreferences: currentUser?.pushPreferences,
           );
         }

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

@@ -320,6 +320,7 @@ extension type const ChannelCapability(String capability) implements String {
   static const searchMessages = ChannelCapability('search-messages');
 
   /// Ability to send typing events.
+  @Deprecated('Use typingEvents instead')
   static const sendTypingEvents = ChannelCapability('send-typing-events');
 
   /// Ability to upload message attachments.

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

@@ -5,7 +5,7 @@ import 'package:stream_chat/src/core/models/user.dart';
 part 'channel_mute.g.dart';
 
 /// The class that contains the information about a muted channel
-@JsonSerializable(createToJson: false)
+@JsonSerializable()
 class ChannelMute {
   /// Constructor used for json serialization
   ChannelMute({
@@ -34,4 +34,7 @@ class ChannelMute {
 
   /// The date in which the mute expires
   final DateTime? expires;
+
+  /// Serialize to json
+  Map<String, dynamic> toJson() => _$ChannelMuteToJson(this);
 }

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

@@ -4,7 +4,7 @@ import 'package:stream_chat/src/core/models/user.dart';
 part 'mute.g.dart';
 
 /// The class that contains the information about a muted user
-@JsonSerializable(createToJson: false)
+@JsonSerializable()
 class Mute {
   /// Constructor used for json serialization
   Mute({
@@ -32,4 +32,7 @@ class Mute {
 
   /// The date in which the mute expires
   final DateTime? expires;
+
+  /// Serialize to json
+  Map<String, dynamic> toJson() => _$MuteToJson(this);
 }