Merge pull request #68 from Iconica-Development/2.0.0

Improve flutter_chat for usage in safino

Author: Gorter-dev

.github/workflows/melos-ci.yml

@@ -11,4 +11,5 @@ jobs:
     secrets: inherit
     permissions: write-all
     with:
-      subfolder: '.' # add optional subfolder to run workflow in
+      subfolder: '.' # add optional subfolder to run workflow in
+      flutter_version: 3.19.6

CHANGELOG.md

@@ -1,3 +1,14 @@
+## 2.0.0
+
+- Add a serviceBuilder to the userstory configuration
+- Add a translationsBuilder to the userstory configuration
+- Change onPressUserProfile callback to use a ChatUserModel instead of a String
+- Add a enableGroupChatCreation boolean to the userstory configuration to enable or disable group chat creation
+- Change the ChatTranslations constructor to require all translations or use the ChatTranslations.empty constructor if you don't want to specify all translations
+- Remove the Divider between the users on the new chat screen
+- Add option to set a custom padding around the list of chats
+- Fix nullpointer when firstWhere returns null because there is only 1 person in a groupchat
+
 ## 1.4.3
 
 - Added default styling.

packages/flutter_chat/lib/src/flutter_chat_navigator_userstory.dart

@@ -4,7 +4,6 @@
 
 import 'package:flutter/material.dart';
 import 'package:flutter_chat/flutter_chat.dart';
-import 'package:uuid/uuid.dart';
 
 /// Navigates to the chat user story screen.
 ///
@@ -96,17 +95,17 @@ Widget _chatDetailScreenRoute(
       service: configuration.chatService,
       chatId: chatId,
       textfieldBottomPadding: configuration.textfieldBottomPadding ?? 0,
-      onPressUserProfile: (userId) async {
+      onPressUserProfile: (user) async {
         if (configuration.onPressUserProfile != null) {
-          return configuration.onPressUserProfile?.call();
+          return configuration.onPressUserProfile?.call(context, user);
         }
         return Navigator.of(context).push(
           MaterialPageRoute(
             builder: (context) => _chatProfileScreenRoute(
               configuration,
               context,
               chatId,
-              userId,
+              user.id,
             ),
           ),
         );
@@ -172,7 +171,7 @@ Widget _chatProfileScreenRoute(
       userId: userId,
       onTapUser: (user) async {
         if (configuration.onPressUserProfile != null) {
-          return configuration.onPressUserProfile!.call();
+          return configuration.onPressUserProfile!.call(context, user);
         }
 
         return Navigator.of(context).push(
@@ -200,6 +199,7 @@ Widget _newChatScreenRoute(
       options: configuration.chatOptionsBuilder(context),
       translations: configuration.translations,
       service: configuration.chatService,
+      showGroupChatButton: configuration.enableGroupChatCreation,
       onPressCreateGroupChat: () async {
         configuration.onPressCreateGroupChat?.call();
         if (context.mounted) {

packages/flutter_chat/lib/src/flutter_chat_userstory.dart

@@ -14,9 +14,11 @@ List<GoRoute> getChatStoryRoutes(
       GoRoute(
         path: ChatUserStoryRoutes.chatScreen,
         pageBuilder: (context, state) {
+          var service = configuration.chatServiceBuilder?.call(context) ??
+              configuration.chatService;
           var chatScreen = ChatScreen(
             unreadMessageTextStyle: configuration.unreadMessageTextStyle,
-            service: configuration.chatService,
+            service: service,
             options: configuration.chatOptionsBuilder(context),
             onNoChats: () async =>
                 context.push(ChatUserStoryRoutes.newChatScreen),
@@ -34,7 +36,8 @@ List<GoRoute> getChatStoryRoutes(
                 configuration.onDeleteChat?.call(context, chat) ??
                 configuration.chatService.chatOverviewService.deleteChat(chat),
             deleteChatDialog: configuration.deleteChatDialog,
-            translations: configuration.translations,
+            translations: configuration.translationsBuilder?.call(context) ??
+                configuration.translations,
           );
           return buildScreenWithoutTransition(
             context: context,
@@ -53,23 +56,26 @@ List<GoRoute> getChatStoryRoutes(
         path: ChatUserStoryRoutes.chatDetailScreen,
         pageBuilder: (context, state) {
           var chatId = state.pathParameters['id'];
+          var service = configuration.chatServiceBuilder?.call(context) ??
+              configuration.chatService;
           var chatDetailScreen = ChatDetailScreen(
             chatTitleBuilder: configuration.chatTitleBuilder,
             usernameBuilder: configuration.usernameBuilder,
             loadingWidgetBuilder: configuration.loadingWidgetBuilder,
             iconDisabledColor: configuration.iconDisabledColor,
             pageSize: configuration.messagePageSize,
             options: configuration.chatOptionsBuilder(context),
-            translations: configuration.translations,
-            service: configuration.chatService,
+            translations: configuration.translationsBuilder?.call(context) ??
+                configuration.translations,
+            service: service,
             chatId: chatId!,
             textfieldBottomPadding: configuration.textfieldBottomPadding ?? 0,
-            onPressUserProfile: (userId) async {
+            onPressUserProfile: (user) async {
               if (configuration.onPressUserProfile != null) {
-                return configuration.onPressUserProfile?.call();
+                return configuration.onPressUserProfile?.call(context, user);
               }
               return context.push(
-                ChatUserStoryRoutes.chatProfileScreenPath(chatId, userId),
+                ChatUserStoryRoutes.chatProfileScreenPath(chatId, user.id),
               );
             },
             onMessageSubmit: (message) async {
@@ -120,10 +126,14 @@ List<GoRoute> getChatStoryRoutes(
       GoRoute(
         path: ChatUserStoryRoutes.newChatScreen,
         pageBuilder: (context, state) {
+          var service = configuration.chatServiceBuilder?.call(context) ??
+              configuration.chatService;
           var newChatScreen = NewChatScreen(
             options: configuration.chatOptionsBuilder(context),
-            translations: configuration.translations,
-            service: configuration.chatService,
+            translations: configuration.translationsBuilder?.call(context) ??
+                configuration.translations,
+            service: service,
+            showGroupChatButton: configuration.enableGroupChatCreation,
             onPressCreateChat: (user) async {
               configuration.onPressCreateChat?.call(user);
               if (configuration.onPressCreateChat != null) return;
@@ -163,10 +173,13 @@ List<GoRoute> getChatStoryRoutes(
       GoRoute(
         path: ChatUserStoryRoutes.newGroupChatScreen,
         pageBuilder: (context, state) {
+          var service = configuration.chatServiceBuilder?.call(context) ??
+              configuration.chatService;
           var newGroupChatScreen = NewGroupChatScreen(
             options: configuration.chatOptionsBuilder(context),
-            translations: configuration.translations,
-            service: configuration.chatService,
+            translations: configuration.translationsBuilder?.call(context) ??
+                configuration.translations,
+            service: service,
             onPressGroupChatOverview: (users) async => context.push(
               ChatUserStoryRoutes.newGroupChatOverviewScreen,
               extra: users,
@@ -188,11 +201,14 @@ List<GoRoute> getChatStoryRoutes(
       GoRoute(
         path: ChatUserStoryRoutes.newGroupChatOverviewScreen,
         pageBuilder: (context, state) {
+          var service = configuration.chatServiceBuilder?.call(context) ??
+              configuration.chatService;
           var users = state.extra! as List<ChatUserModel>;
           var newGroupChatOverviewScreen = NewGroupChatOverviewScreen(
             options: configuration.chatOptionsBuilder(context),
-            translations: configuration.translations,
-            service: configuration.chatService,
+            translations: configuration.translationsBuilder?.call(context) ??
+                configuration.translations,
+            service: service,
             users: users,
             onPressCompleteGroupChatCreation: (users, groupChatName) async {
               configuration.onPressCompleteGroupChatCreation
@@ -232,18 +248,21 @@ List<GoRoute> getChatStoryRoutes(
           var chatId = state.pathParameters['id'];
           var userId = state.pathParameters['userId'];
           var id = userId == 'null' ? null : userId;
+          var service = configuration.chatServiceBuilder?.call(context) ??
+              configuration.chatService;
           var profileScreen = ChatProfileScreen(
-            translations: configuration.translations,
-            chatService: configuration.chatService,
+            translations: configuration.translationsBuilder?.call(context) ??
+                configuration.translations,
+            chatService: service,
             chatId: chatId!,
             userId: id,
             onTapUser: (user) async {
               if (configuration.onPressUserProfile != null) {
-                return configuration.onPressUserProfile!.call();
+                return configuration.onPressUserProfile!.call(context, user);
               }
 
               return context.push(
-                ChatUserStoryRoutes.chatProfileScreenPath(chatId, user),
+                ChatUserStoryRoutes.chatProfileScreenPath(chatId, user.id),
               );
             },
           );

packages/flutter_chat/lib/src/models/chat_configuration.dart

@@ -14,6 +14,7 @@ class ChatUserStoryConfiguration {
   const ChatUserStoryConfiguration({
     required this.chatService,
     required this.chatOptionsBuilder,
+    this.chatServiceBuilder,
     this.onPressStartChat,
     this.onPressChat,
     this.onDeleteChat,
@@ -27,7 +28,9 @@ class ChatUserStoryConfiguration {
     this.deleteChatDialog,
     this.disableDismissForPermanentChats = false,
     this.routeToNewChatIfEmpty = true,
-    this.translations = const ChatTranslations(),
+    this.enableGroupChatCreation = true,
+    this.translations = const ChatTranslations.empty(),
+    this.translationsBuilder,
     this.chatPageBuilder,
     this.onPressChatTitle,
     this.afterMessageSent,
@@ -44,6 +47,9 @@ class ChatUserStoryConfiguration {
   /// The service responsible for handling chat-related functionalities.
   final ChatService chatService;
 
+  /// A method to get the chat service only when needed and with a context.
+  final ChatService Function(BuildContext context)? chatServiceBuilder;
+
   /// Callback function triggered when a chat is pressed.
   final Function(BuildContext, ChatModel)? onPressChat;
 
@@ -53,6 +59,9 @@ class ChatUserStoryConfiguration {
   /// Translations for internationalization/localization support.
   final ChatTranslations translations;
 
+  /// Translations builder because context might be needed for translations.
+  final ChatTranslations Function(BuildContext context)? translationsBuilder;
+
   /// Determines whether dismissing is disabled for permanent chats.
   final bool disableDismissForPermanentChats;
 
@@ -74,7 +83,10 @@ class ChatUserStoryConfiguration {
 
   /// Builder for chat options based on context.
   final Function(List<ChatUserModel>, String)? onPressCompleteGroupChatCreation;
+
   final Function()? onPressCreateGroupChat;
+
+  /// Builder for the chat options which can be used to style the UI of the chat
   final ChatOptions Function(BuildContext context) chatOptionsBuilder;
 
   /// If true, the user will be routed to the new chat screen if there are
@@ -84,6 +96,10 @@ class ChatUserStoryConfiguration {
   /// The size of each page of messages.
   final int messagePageSize;
 
+  /// Whether to enable group chat creation for the user. If false,
+  /// the button will be hidden
+  final bool enableGroupChatCreation;
+
   /// Dialog for confirming chat deletion.
   final Future<bool?> Function(BuildContext, ChatModel)? deleteChatDialog;
 
@@ -100,11 +116,18 @@ class ChatUserStoryConfiguration {
   final Function()? onPressStartChat;
 
   /// Callback function triggered when user profile is pressed.
-  final Function()? onPressUserProfile;
+  final Function(BuildContext context, ChatUserModel user)? onPressUserProfile;
+
   final double? textfieldBottomPadding;
+
   final Color? iconDisabledColor;
+
+  /// The text style used for the unread message counter.
   final TextStyle? unreadMessageTextStyle;
+
   final Widget? Function(BuildContext context)? loadingWidgetBuilder;
+
   final Widget Function(String userFullName)? usernameBuilder;
+
   final Widget Function(String chatTitle)? chatTitleBuilder;
 }

packages/flutter_chat/pubspec.yaml

@@ -4,7 +4,7 @@
 
 name: flutter_chat
 description: A new Flutter package project.
-version: 1.4.3
+version: 2.0.0
 
 publish_to: none
 
@@ -20,17 +20,17 @@ dependencies:
     git:
       url: https://github.com/Iconica-Development/flutter_chat
       path: packages/flutter_chat_view
-      ref: 1.4.3
+      ref: 2.0.0
   flutter_chat_interface:
     git:
       url: https://github.com/Iconica-Development/flutter_chat
       path: packages/flutter_chat_interface
-      ref: 1.4.3
+      ref: 2.0.0
   flutter_chat_local:
     git:
       url: https://github.com/Iconica-Development/flutter_chat
       path: packages/flutter_chat_local
-      ref: 1.4.3
+      ref: 2.0.0
   uuid: ^4.3.3
 
 dev_dependencies:

packages/flutter_chat_firebase/lib/service/firebase_chat_overview_service.dart

@@ -91,11 +91,15 @@ class FirebaseChatOverviewService implements ChatOverviewService {
               var chat = element.doc.data();
               if (chat == null) return;
 
-              var otherUser = await _userService.getUser(
-                chat.users.firstWhere(
-                  (element) => element != currentUser?.id,
-                ),
-              );
+              var otherUser = chat.users.any(
+                (element) => element != currentUser?.id,
+              )
+                  ? await _userService.getUser(
+                      chat.users.firstWhere(
+                        (element) => element != currentUser?.id,
+                      ),
+                    )
+                  : null;
 
               var unread =
                   await _addUnreadChatSubscription(chat.id!, currentUser!.id!);
@@ -144,18 +148,18 @@ class FirebaseChatOverviewService implements ChatOverviewService {
                   imageUrl: chat.imageUrl ?? '',
                   unreadMessages: unread,
                   users: users,
-                  lastMessage: chat.lastMessage != null
+                  lastMessage: chat.lastMessage != null && otherUser != null
                       ? chat.lastMessage!.imageUrl == null
                           ? ChatTextMessageModel(
-                              sender: otherUser!,
+                              sender: otherUser,
                               text: chat.lastMessage!.text!,
                               timestamp: DateTime.fromMillisecondsSinceEpoch(
                                 chat.lastMessage!.timestamp
                                     .millisecondsSinceEpoch,
                               ),
                             )
                           : ChatImageMessageModel(
-                              sender: otherUser!,
+                              sender: otherUser,
                               imageUrl: chat.lastMessage!.imageUrl!,
                               timestamp: DateTime.fromMillisecondsSinceEpoch(
                                 chat.lastMessage!.timestamp

packages/flutter_chat_firebase/pubspec.yaml

@@ -4,7 +4,7 @@
 
 name: flutter_chat_firebase
 description: A new Flutter package project.
-version: 1.4.3
+version: 2.0.0
 publish_to: none
 
 environment:
@@ -23,7 +23,7 @@ dependencies:
     git:
       url: https://github.com/Iconica-Development/flutter_chat
       path: packages/flutter_chat_interface
-      ref: 1.4.3
+      ref: 2.0.0
 
 dev_dependencies:
   flutter_iconica_analysis:

packages/flutter_chat_interface/pubspec.yaml

@@ -4,7 +4,7 @@
 
 name: flutter_chat_interface
 description: A new Flutter package project.
-version: 1.4.3
+version: 2.0.0
 publish_to: none
 
 environment:

packages/flutter_chat_local/pubspec.yaml

@@ -1,8 +1,7 @@
 name: flutter_chat_local
 description: "A new Flutter package project."
-version: 1.4.3
+version: 2.0.0
 publish_to: none
-homepage:
 
 environment:
   sdk: ">=3.2.5 <4.0.0"
@@ -15,7 +14,7 @@ dependencies:
     git:
       url: https://github.com/Iconica-Development/flutter_chat
       path: packages/flutter_chat_interface
-      ref: 1.4.3
+      ref: 2.0.0
 
 dev_dependencies:
   flutter_test: