feat(llc): add AI events (#2057)

* feat(llc): AI events

* chore: update CHANGELOG.md

* test: update tests

* test: add more tests

* chore: fix analyzer warning

Author: xsahil03x

packages/stream_chat/CHANGELOG.md

@@ -1,3 +1,9 @@
+## Upcoming
+
+✅ Added
+
+- Added support for AI assistant states and events.
+
 ## 8.2.0
 
 ✅ Added

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

@@ -1158,6 +1158,16 @@ class Channel {
     }
   }
 
+  /// Sends an event to stop AI response generation, leaving the message in
+  /// its current state.
+  Future<EmptyResponse> stopAIResponse() async {
+    return sendEvent(
+      Event(
+        type: EventType.aiIndicatorStop,
+      ),
+    );
+  }
+
   /// Update the channel's [name].
   ///
   /// This is the same as calling [updatePartial] and providing a map with a
@@ -1961,8 +1971,8 @@ class ChannelClientState {
           final existingWatchers = channelState.watchers;
           updateChannelState(channelState.copyWith(
             watchers: [
-              ...?existingWatchers,
               watcher,
+              ...?existingWatchers?.where((user) => user.id != watcher.id),
             ],
           ));
         }
@@ -1977,9 +1987,9 @@ class ChannelClientState {
         if (watcher != null) {
           final existingWatchers = channelState.watchers;
           updateChannelState(channelState.copyWith(
-            watchers: existingWatchers
-                ?.where((user) => user.id != watcher.id)
-                .toList(growable: false),
+            watchers: [
+              ...?existingWatchers?.where((user) => user.id != watcher.id)
+            ],
           ));
         }
       }),
@@ -2367,7 +2377,7 @@ class ChannelClientState {
         channelStateStream.map((cs) => cs.members),
         _channel.client.state.usersStream,
         (members, users) =>
-            members!.map((e) => e!.copyWith(user: users[e.user!.id])).toList(),
+            [...?members?.map((e) => e!.copyWith(user: users[e.user!.id]))],
       ).distinct(const ListEquality().equals);
 
   /// Channel watcher count.
@@ -2387,7 +2397,7 @@ class ChannelClientState {
           List<User>?, Map<String?, User?>, List<User>>(
         channelStateStream.map((cs) => cs.watchers),
         _channel.client.state.usersStream,
-        (watchers, users) => watchers!.map((e) => users[e.id] ?? e).toList(),
+        (watchers, users) => [...?watchers?.map((e) => users[e.id] ?? e)],
       ).distinct(const ListEquality().equals);
 
   /// Channel member for the current user.

packages/stream_chat/lib/src/core/error/stream_chat_error.dart

@@ -76,9 +76,11 @@ class StreamChatNetworkError extends StreamChatError {
     ChatErrorCode errorCode, {
     int? statusCode,
     this.data,
+    StackTrace? stacktrace,
     this.isRequestCancelledError = false,
   })  : code = errorCode.code,
         statusCode = statusCode ?? data?.statusCode,
+        stackTrace = stacktrace ?? StackTrace.current,
         super(errorCode.message);
 
   ///
@@ -87,8 +89,10 @@ class StreamChatNetworkError extends StreamChatError {
     required String message,
     this.statusCode,
     this.data,
+    StackTrace? stacktrace,
     this.isRequestCancelledError = false,
-  }) : super(message);
+  })  : stackTrace = stacktrace ?? StackTrace.current,
+        super(message);
 
   ///
   factory StreamChatNetworkError.fromDioException(DioException exception) {
@@ -108,8 +112,9 @@ class StreamChatNetworkError extends StreamChatError {
           '',
       statusCode: errorResponse?.statusCode ?? response?.statusCode,
       data: errorResponse,
+      stacktrace: exception.stackTrace,
       isRequestCancelledError: exception.type == DioExceptionType.cancel,
-    )..stackTrace = exception.stackTrace;
+    );
   }
 
   /// Error code
@@ -124,10 +129,8 @@ class StreamChatNetworkError extends StreamChatError {
   /// True, in case the error is due to a cancelled network request.
   final bool isRequestCancelledError;
 
-  StackTrace? _stackTrace;
-
-  ///
-  set stackTrace(StackTrace? stack) => _stackTrace = stack;
+  /// The optional stack trace attached to the error.
+  final StackTrace? stackTrace;
 
   ///
   ChatErrorCode? get errorCode => chatErrorCodeFromCode(code);
@@ -145,8 +148,8 @@ class StreamChatNetworkError extends StreamChatError {
     if (data != null) params += ', data: $data';
     var msg = 'StreamChatNetworkError($params)';
 
-    if (printStackTrace && _stackTrace != null) {
-      msg += '\n$_stackTrace';
+    if (printStackTrace && stackTrace != null) {
+      msg += '\n$stackTrace';
     }
     return msg;
   }

packages/stream_chat/lib/src/core/http/interceptor/auth_interceptor.dart

@@ -30,6 +30,7 @@ class AuthInterceptor extends QueuedInterceptor {
       final dioError = StreamChatDioError(
         error: error,
         requestOptions: options,
+        stackTrace: StackTrace.current,
       );
       return handler.reject(dioError, true);
     }

packages/stream_chat/lib/src/core/http/stream_chat_dio_error.dart

@@ -9,8 +9,11 @@ class StreamChatDioError extends DioException {
     required super.requestOptions,
     super.response,
     super.type,
+    StackTrace? stackTrace,
+    super.message,
   }) : super(
           error: error,
+          stackTrace: stackTrace ?? StackTrace.current,
         );
 
   @override

packages/stream_chat/lib/src/core/http/stream_http_client.dart

@@ -97,15 +97,10 @@ class StreamHttpClient {
   void close({bool force = false}) => httpClient.close(force: force);
 
   StreamChatNetworkError _parseError(DioException exception) {
-    StreamChatNetworkError error;
     // locally thrown dio error
-    if (exception is StreamChatDioError) {
-      error = exception.error;
-    } else {
-      // real network request dio error
-      error = StreamChatNetworkError.fromDioException(exception);
-    }
-    return error..stackTrace = exception.stackTrace;
+    if (exception is StreamChatDioError) return exception.error;
+    // real network request dio error
+    return StreamChatNetworkError.fromDioException(exception);
   }
 
   /// Handy method to make http GET request with error parsing.

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

@@ -26,6 +26,9 @@ class Event {
     this.channelType,
     this.parentId,
     this.hardDelete,
+    this.aiState,
+    this.aiMessage,
+    this.messageId,
     this.extraData = const {},
     this.isLocal = true,
   }) : createdAt = createdAt?.toUtc() ?? DateTime.now().toUtc();
@@ -94,6 +97,16 @@ class Event {
   @JsonKey(includeIfNull: false)
   final bool? hardDelete;
 
+  /// The current state of the AI assistant.
+  @JsonKey(unknownEnumValue: AITypingState.idle)
+  final AITypingState? aiState;
+
+  /// Additional message from the AI assistant.
+  final String? aiMessage;
+
+  /// The message id to which the event belongs.
+  final String? messageId;
+
   /// Map of custom channel extraData
   final Map<String, Object?> extraData;
 
@@ -136,6 +149,9 @@ class Event {
     'parent_id',
     'hard_delete',
     'is_local',
+    'ai_state',
+    'ai_message',
+    'message_id',
   ];
 
   /// Serialize to json
@@ -162,6 +178,9 @@ class Event {
     bool? online,
     String? parentId,
     bool? hardDelete,
+    AITypingState? aiState,
+    String? aiMessage,
+    String? messageId,
     Map<String, Object?>? extraData,
   }) =>
       Event(
@@ -183,14 +202,15 @@ class Event {
         parentId: parentId ?? this.parentId,
         hardDelete: hardDelete ?? this.hardDelete,
         extraData: extraData ?? this.extraData,
+        aiState: aiState ?? this.aiState,
+        aiMessage: aiMessage ?? this.aiMessage,
+        messageId: messageId ?? this.messageId,
         isLocal: isLocal,
       );
 }
 
 /// The channel embedded in the event object
-@JsonSerializable(
-  createToJson: false,
-)
+@JsonSerializable(createToJson: false)
 class EventChannel extends ChannelModel {
   /// Constructor used for json serialization
   EventChannel({
@@ -207,12 +227,12 @@ class EventChannel extends ChannelModel {
     required DateTime super.updatedAt,
     super.deletedAt,
     super.memberCount,
-    Map<String, Object?>? extraData,
     super.cooldown,
     super.team,
     super.disabled,
     super.hidden,
     super.truncatedAt,
+    Map<String, Object?>? extraData,
   }) : super(extraData: extraData ?? {});
 
   /// Create a new instance from a json
@@ -232,3 +252,31 @@ class EventChannel extends ChannelModel {
     ...ChannelModel.topLevelFields,
   ];
 }
+
+/// {@template aiState}
+/// The current typing state of the AI assistant.
+///
+/// This is used to determine the state of the AI assistant when it's generating
+/// a response for the provided query.
+/// {@endtemplate}
+enum AITypingState {
+  /// The AI assistant is idle.
+  @JsonValue('AI_STATE_IDLE')
+  idle,
+
+  /// The AI assistant is in an error state.
+  @JsonValue('AI_STATE_ERROR')
+  error,
+
+  /// The AI assistant is checking external sources.
+  @JsonValue('AI_STATE_CHECKING_SOURCES')
+  checkingSources,
+
+  /// The AI assistant is thinking.
+  @JsonValue('AI_STATE_THINKING')
+  thinking,
+
+  /// The AI assistant is generating a response.
+  @JsonValue('AI_STATE_GENERATING')
+  generating,
+}

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

@@ -112,4 +112,13 @@ class EventType {
 
   /// Event sent when the user's mutes list is updated
   static const String notificationMutesUpdated = 'notification.mutes_updated';
+
+  /// Event sent when the AI indicator is updated
+  static const String aiIndicatorUpdate = 'ai_indicator.update';
+
+  /// Event sent when the AI indicator is stopped
+  static const String aiIndicatorStop = 'ai_indicator.stop';
+
+  /// Event sent when the AI indicator is cleared
+  static const String aiIndicatorClear = 'ai_indicator.clear';
 }

packages/stream_chat/lib/src/event_type.dart

@@ -25,5 +25,7 @@
     "online": false,
     "image": "https://getstream.io/random_svg/?name=Dry+meadow",
     "name": "Dry meadow"
-  }
+  },
+  "ai_state": "AI_STATE_THINKING",
+  "ai_message": "Some message"
 }