internal/flutter_chat
5
0
Fork 0
mirror of https://github.com/Iconica-Development/flutter_chat.git synced 2025-05-18 18:33:49 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

fix: add remaining documentation and fix deep nesting

Browse source
This commit is contained in:
Joey Boerwinkel 2024-10-22 10:03:46 +02:00 committed by Freek van de Ven
parent b6fc7b2cb0
commit bd14f5cd6d
8 changed files with 294 additions and 277 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
.fvmrc Normal file
View file

@ -0,0 +1,3 @@
{
"flutter": "3.24.3"
}

53
packages/chat_repository_interface/lib/src/models/chat_model.dart
View file

@ -25,6 +25,22 @@ class ChatModel {
this.unreadMessageCount = 0, this.unreadMessageCount = 0,
}); });
/// The factory chat model that creates a chat model from a map
factory ChatModel.fromMap(String id, Map<String, dynamic> data) => ChatModel(
id: id,
users: List<String>.from(data["users"]),
isGroupChat: data["isGroupChat"],
chatName: data["chatName"],
description: data["description"],
imageUrl: data["imageUrl"],
canBeDeleted: data["canBeDeleted"] ?? true,
lastUsed: data["lastUsed"] != null
? DateTime.fromMillisecondsSinceEpoch(data["lastUsed"])
: null,
lastMessage: data["lastMessage"],
unreadMessageCount: data["unreadMessageCount"] ?? 0,
);
/// The chat id /// The chat id
final String id; final String id;
@ -81,34 +97,17 @@ class ChatModel {
unreadMessageCount: unreadMessageCount ?? this.unreadMessageCount, unreadMessageCount: unreadMessageCount ?? this.unreadMessageCount,
); );
/// The factory chat model that creates a chat model from a map /// Creates a map representation of this object
factory ChatModel.fromMap(String id, Map<String, dynamic> data) {
return ChatModel(
id: id,
users: List<String>.from(data['users']),
isGroupChat: data['isGroupChat'],
chatName: data['chatName'],
description: data['description'],
imageUrl: data['imageUrl'],
canBeDeleted: data['canBeDeleted'] ?? true,
lastUsed: data['lastUsed'] != null
? DateTime.fromMillisecondsSinceEpoch(data['lastUsed'])
: null,
lastMessage: data['lastMessage'],
unreadMessageCount: data['unreadMessageCount'] ?? 0,
);
}
Map<String, dynamic> toMap() => { Map<String, dynamic> toMap() => {
'users': users, "users": users,
'isGroupChat': isGroupChat, "isGroupChat": isGroupChat,
'chatName': chatName, "chatName": chatName,
'description': description, "description": description,
'imageUrl': imageUrl, "imageUrl": imageUrl,
'canBeDeleted': canBeDeleted, "canBeDeleted": canBeDeleted,
'lastUsed': lastUsed?.millisecondsSinceEpoch, "lastUsed": lastUsed?.millisecondsSinceEpoch,
'lastMessage': lastMessage, "lastMessage": lastMessage,
'unreadMessageCount': unreadMessageCount, "unreadMessageCount": unreadMessageCount,
}; };
} }

37
packages/chat_repository_interface/lib/src/models/message_model.dart
View file

@ -16,6 +16,17 @@ class MessageModel {
required this.senderId, required this.senderId,
}); });
/// Creates a message model instance given a map instance
factory MessageModel.fromMap(String id, Map<String, dynamic> map) =>
MessageModel(
chatId: map["chatId"],
id: id,
text: map["text"],
imageUrl: map["imageUrl"],
timestamp: DateTime.fromMillisecondsSinceEpoch(map["timestamp"]),
senderId: map["senderId"],
);
/// The chat id /// The chat id
final String chatId; final String chatId;
@ -52,27 +63,15 @@ class MessageModel {
senderId: senderId ?? this.senderId, senderId: senderId ?? this.senderId,
); );
factory MessageModel.fromMap(String id, Map<String, dynamic> map) { /// Creates a map representation of this object
return MessageModel( Map<String, dynamic> toMap() => {
chatId: map['chatId'], "chatId": chatId,
id: id, "text": text,
text: map['text'], "imageUrl": imageUrl,
imageUrl: map['imageUrl'], "timestamp": timestamp.millisecondsSinceEpoch,
timestamp: DateTime.fromMillisecondsSinceEpoch(map['timestamp']), "senderId": senderId,
senderId: map['senderId'],
);
}
Map<String, dynamic> toMap() {
return {
'chatId': chatId,
'text': text,
'imageUrl': imageUrl,
'timestamp': timestamp.millisecondsSinceEpoch,
'senderId': senderId,
}; };
} }
}
/// Extension on [MessageModel] to check the message type /// Extension on [MessageModel] to check the message type
extension MessageType on MessageModel { extension MessageType on MessageModel {

17
packages/chat_repository_interface/lib/src/models/user_model.dart
View file

@ -14,6 +14,14 @@ class UserModel {
this.imageUrl, this.imageUrl,
}); });
/// Creates a user based on a given map [data]
factory UserModel.fromMap(String id, Map<String, dynamic> data) => UserModel(
id: id,
firstName: data["first_name"],
lastName: data["last_name"],
imageUrl: data["image_url"],
);
/// The user id /// The user id
final String id; final String id;
@ -25,15 +33,6 @@ class UserModel {
/// The user image url /// The user image url
final String? imageUrl; final String? imageUrl;
factory UserModel.fromMap(String id, Map<String, dynamic> data) {
return UserModel(
id: id,
firstName: data['firstName'],
lastName: data['lastName'],
imageUrl: data['imageUrl'],
);
}
} }
/// Extension on [UserModel] to get the user full name /// Extension on [UserModel] to get the user full name

159
packages/firebase_chat_repository/lib/src/firebase_chat_repository.dart
View file

@ -1,24 +1,28 @@
import 'dart:typed_data'; import "dart:typed_data";
import 'package:chat_repository_interface/chat_repository_interface.dart'; import "package:chat_repository_interface/chat_repository_interface.dart";
import 'package:cloud_firestore/cloud_firestore.dart'; import "package:cloud_firestore/cloud_firestore.dart";
import 'package:firebase_storage/firebase_storage.dart'; import "package:firebase_storage/firebase_storage.dart";
/// Firebase implementation of the chat repository
class FirebaseChatRepository implements ChatRepositoryInterface { class FirebaseChatRepository implements ChatRepositoryInterface {
final FirebaseFirestore _firestore; /// Creates a firebase implementation of the chat repository
final FirebaseStorage _storage;
final String chatCollection;
final String messageCollection;
final String mediaPath;
FirebaseChatRepository({ FirebaseChatRepository({
FirebaseFirestore? firestore, FirebaseFirestore? firestore,
FirebaseStorage? storage, FirebaseStorage? storage,
this.chatCollection = 'chats', String chatCollection = "chats",
this.messageCollection = 'messages', String messageCollection = "messages",
this.mediaPath = 'chat', String mediaPath = "chat",
}) : _firestore = firestore ?? FirebaseFirestore.instance, }) : _mediaPath = mediaPath,
_messageCollection = messageCollection,
_chatCollection = chatCollection,
_firestore = firestore ?? FirebaseFirestore.instance,
_storage = storage ?? FirebaseStorage.instance; _storage = storage ?? FirebaseStorage.instance;
final FirebaseFirestore _firestore;
final FirebaseStorage _storage;
final String _chatCollection;
final String _messageCollection;
final String _mediaPath;
@override @override
Future<void> createChat({ Future<void> createChat({
@ -29,65 +33,62 @@ class FirebaseChatRepository implements ChatRepositoryInterface {
String? imageUrl, String? imageUrl,
List<MessageModel>? messages, List<MessageModel>? messages,
}) async { }) async {
final chatData = { var chatData = {
'users': users, "users": users,
'isGroupChat': isGroupChat, "isGroupChat": isGroupChat,
'chatName': chatName, "chatName": chatName,
'description': description, "description": description,
'imageUrl': imageUrl, "imageUrl": imageUrl,
'createdAt': DateTime.now().millisecondsSinceEpoch, "createdAt": DateTime.now().millisecondsSinceEpoch,
}; };
await _firestore.collection(chatCollection).add(chatData); await _firestore.collection(_chatCollection).add(chatData);
} }
@override @override
Future<void> deleteChat({required String chatId}) async { Future<void> deleteChat({required String chatId}) async {
await _firestore.collection(chatCollection).doc(chatId).delete(); await _firestore.collection(_chatCollection).doc(chatId).delete();
} }
@override @override
Stream<ChatModel> getChat({required String chatId}) { Stream<ChatModel> getChat({required String chatId}) => _firestore
return _firestore .collection(_chatCollection)
.collection(chatCollection)
.doc(chatId) .doc(chatId)
.snapshots() .snapshots()
.map((snapshot) { .map((snapshot) {
var data = snapshot.data() as Map<String, dynamic>; var data = snapshot.data()!;
return ChatModel.fromMap(snapshot.id, data); return ChatModel.fromMap(snapshot.id, data);
}); });
}
@override @override
Stream<List<ChatModel>?> getChats({required String userId}) { Stream<List<ChatModel>?> getChats({required String userId}) => _firestore
return _firestore .collection(_chatCollection)
.collection(chatCollection) .where("users", arrayContains: userId)
.where('users', arrayContains: userId)
.snapshots() .snapshots()
.map((querySnapshot) { .map(
return querySnapshot.docs.map((doc) { (querySnapshot) => querySnapshot.docs.map((doc) {
var data = doc.data(); var data = doc.data();
return ChatModel.fromMap(doc.id, data); return ChatModel.fromMap(doc.id, data);
}).toList(); }).toList(),
}); );
}
@override @override
Stream<MessageModel?> getMessage( Stream<MessageModel?> getMessage({
{required String chatId, required String messageId}) { required String chatId,
return _firestore required String messageId,
.collection(chatCollection) }) =>
_firestore
.collection(_chatCollection)
.doc(chatId) .doc(chatId)
.collection(messageCollection) .collection(_messageCollection)
.doc(messageId) .doc(messageId)
.snapshots() .snapshots()
.map((snapshot) { .map((snapshot) {
var data = snapshot.data() as Map<String, dynamic>; var data = snapshot.data()!;
return MessageModel.fromMap( return MessageModel.fromMap(
snapshot.id, snapshot.id,
data, data,
); );
}); });
}
@override @override
Stream<List<MessageModel>?> getMessages({ Stream<List<MessageModel>?> getMessages({
@ -95,41 +96,46 @@ class FirebaseChatRepository implements ChatRepositoryInterface {
required String userId, required String userId,
required int pageSize, required int pageSize,
required int page, required int page,
}) { }) =>
return _firestore _firestore
.collection(chatCollection) .collection(_chatCollection)
.doc(chatId) .doc(chatId)
.collection(messageCollection) .collection(_messageCollection)
.orderBy('timestamp') .orderBy("timestamp")
.limit(pageSize) .limit(pageSize)
.snapshots() .snapshots()
.map((query) => query.docs .map(
.map((snapshot) => MessageModel.fromMap( (query) => query.docs
.map(
(snapshot) => MessageModel.fromMap(
snapshot.id, snapshot.id,
snapshot.data(), snapshot.data(),
)) ),
.toList()); )
} .toList(),
);
@override @override
Stream<int> getUnreadMessagesCount( Stream<int> getUnreadMessagesCount({
{required String userId, String? chatId}) async* { required String userId,
String? chatId,
}) async* {
var query = _firestore var query = _firestore
.collection(chatCollection) .collection(_chatCollection)
.where('users', arrayContains: userId) .where("users", arrayContains: userId)
.where('unreadMessageCount', isGreaterThan: 0) .where("unreadMessageCount", isGreaterThan: 0)
.snapshots(); .snapshots();
await for (var snapshot in query) { await for (var snapshot in query) {
var count = 0; var count = 0;
for (var doc in snapshot.docs) { for (var doc in snapshot.docs) {
var data = doc.data(); var data = doc.data();
var lastMessageKey = data['lastMessage']; var lastMessageKey = data["lastMessage"];
var message = var message =
await getMessage(chatId: doc.id, messageId: lastMessageKey).first; await getMessage(chatId: doc.id, messageId: lastMessageKey).first;
if (message?.senderId != userId) { if (message?.senderId != userId) {
count += data['unreadMessageCount'] as int; count += data["unreadMessageCount"] as int;
} }
} }
@ -152,22 +158,23 @@ class FirebaseChatRepository implements ChatRepositoryInterface {
text: text, text: text,
imageUrl: imageUrl, imageUrl: imageUrl,
timestamp: timestamp ?? DateTime.now(), timestamp: timestamp ?? DateTime.now(),
senderId: senderId); senderId: senderId,
);
await _firestore await _firestore
.collection(chatCollection) .collection(_chatCollection)
.doc(chatId) .doc(chatId)
.collection(messageCollection) .collection(_messageCollection)
.doc(messageId) .doc(messageId)
.set( .set(
message.toMap(), message.toMap(),
); );
await _firestore.collection(chatCollection).doc(chatId).update( await _firestore.collection(_chatCollection).doc(chatId).update(
{ {
'lastMessage': messageId, "lastMessage": messageId,
'unreadMessageCount': FieldValue.increment(1), "unreadMessageCount": FieldValue.increment(1),
'lastUsed': DateTime.now().millisecondsSinceEpoch, "lastUsed": DateTime.now().millisecondsSinceEpoch,
}, },
); );
} }
@ -175,17 +182,19 @@ class FirebaseChatRepository implements ChatRepositoryInterface {
@override @override
Future<void> updateChat({required ChatModel chat}) async { Future<void> updateChat({required ChatModel chat}) async {
await _firestore await _firestore
.collection(chatCollection) .collection(_chatCollection)
.doc(chat.id) .doc(chat.id)
.update(chat.toMap()); .update(chat.toMap());
} }
@override @override
Future<String> uploadImage( Future<String> uploadImage({
{required String path, required Uint8List image}) async { required String path,
final ref = _storage.ref().child(mediaPath).child(path); required Uint8List image,
final uploadTask = ref.putData(image); }) async {
final snapshot = await uploadTask.whenComplete(() => {}); var ref = _storage.ref().child(_mediaPath).child(path);
return await snapshot.ref.getDownloadURL(); var uploadTask = ref.putData(image);
var snapshot = await uploadTask.whenComplete(() => {});
return snapshot.ref.getDownloadURL();
} }
} }

51
packages/firebase_chat_repository/lib/src/firebase_user_repository.dart
View file

@ -1,41 +1,36 @@
import 'package:chat_repository_interface/chat_repository_interface.dart'; import "package:chat_repository_interface/chat_repository_interface.dart";
import 'package:cloud_firestore/cloud_firestore.dart'; import "package:cloud_firestore/cloud_firestore.dart";
/// Firebase implementation of a user respository for chats.
class FirebaseUserRepository implements UserRepositoryInterface { class FirebaseUserRepository implements UserRepositoryInterface {
final FirebaseFirestore _firestore; /// Creates a firebase implementation of a user respository for chats.
final String userCollection;
FirebaseUserRepository({ FirebaseUserRepository({
FirebaseFirestore? firestore, FirebaseFirestore? firestore,
this.userCollection = 'users', String userCollection = "users",
}) : _firestore = firestore ?? FirebaseFirestore.instance; }) : _userCollection = userCollection,
_firestore = firestore ?? FirebaseFirestore.instance;
final FirebaseFirestore _firestore;
final String _userCollection;
@override @override
Stream<List<UserModel>> getAllUsers() { Stream<List<UserModel>> getAllUsers() =>
return _firestore _firestore.collection(_userCollection).snapshots().map(
.collection(userCollection) (querySnapshot) => querySnapshot.docs
.snapshots() .map(
.map((querySnapshot) { (doc) => UserModel.fromMap(
return querySnapshot.docs
.map((doc) => UserModel.fromMap(
doc.id, doc.id,
doc.data(), doc.data(),
)) ),
.toList(); )
}); .toList(),
} );
@override @override
Stream<UserModel> getUser({required String userId}) { Stream<UserModel> getUser({required String userId}) =>
return _firestore _firestore.collection(_userCollection).doc(userId).snapshots().map(
.collection(userCollection) (snapshot) => UserModel.fromMap(
.doc(userId)
.snapshots()
.map((snapshot) {
return UserModel.fromMap(
snapshot.id, snapshot.id,
snapshot.data() as Map<String, dynamic>, snapshot.data()!,
),
); );
});
}
} }

39
packages/flutter_chat/lib/src/config/screen_types.dart
View file

@ -1,28 +1,41 @@
import 'package:flutter/material.dart'; import "package:flutter/material.dart";
import 'package:flutter_chat/src/screens/chat_detail_screen.dart'; import "package:flutter_chat/src/screens/chat_detail_screen.dart";
import 'package:flutter_chat/src/screens/chat_profile_screen.dart'; import "package:flutter_chat/src/screens/chat_profile_screen.dart";
import 'package:flutter_chat/src/screens/chat_screen.dart'; import "package:flutter_chat/src/screens/chat_screen.dart";
import 'package:flutter_chat/src/screens/creation/new_chat_screen.dart'; import "package:flutter_chat/src/screens/creation/new_chat_screen.dart";
import 'package:flutter_chat/src/screens/creation/new_group_chat_overview.dart'; import "package:flutter_chat/src/screens/creation/new_group_chat_overview.dart";
import 'package:flutter_chat/src/screens/creation/new_group_chat_screen.dart'; import "package:flutter_chat/src/screens/creation/new_group_chat_screen.dart";
/// Type of screen, used in custom screen builders
enum ScreenType { enum ScreenType {
/// Screen displaying an overview of chats
chatScreen(screen: ChatScreen), chatScreen(screen: ChatScreen),
/// Screen displaying a single chat
chatDetailScreen(screen: ChatDetailScreen), chatDetailScreen(screen: ChatDetailScreen),
/// Screen displaying the profile of a user within a chat
chatProfileScreen(screen: ChatProfileScreen), chatProfileScreen(screen: ChatProfileScreen),
/// Screen with a form to create a new chat
newChatScreen(screen: NewChatScreen), newChatScreen(screen: NewChatScreen),
/// Screen with a form to create a new group chat
newGroupChatScreen(screen: NewGroupChatScreen), newGroupChatScreen(screen: NewGroupChatScreen),
/// Screen displaying all group chats
newGroupChatOverview(screen: NewGroupChatOverview); newGroupChatOverview(screen: NewGroupChatOverview);
const ScreenType({ const ScreenType({
required this.screen, required Type screen,
}); }) : _screen = screen;
final Type screen; final Type _screen;
} }
/// Extension for mapping widgets to [ScreenType]s
extension MapFromWidget on Widget { extension MapFromWidget on Widget {
ScreenType get mapScreenType { /// returns corresponding [ScreenType]
return ScreenType.values.firstWhere((e) => e.screen == this.runtimeType); ScreenType get mapScreenType =>
} ScreenType.values.firstWhere((e) => e._screen == runtimeType);
} }

146
packages/flutter_chat/lib/src/screens/chat_profile_screen.dart
View file

@ -35,6 +35,7 @@ class ChatProfileScreen extends StatelessWidget {
/// Callback function triggered when a user is tapped /// Callback function triggered when a user is tapped
final Function(String)? onTapUser; final Function(String)? onTapUser;
/// instance of a chat service
final ChatService service; final ChatService service;
/// Callback function triggered when the start chat button is pressed /// Callback function triggered when the start chat button is pressed
@ -135,6 +136,76 @@ class _Body extends StatelessWidget {
@override @override
Widget build(BuildContext context) { Widget build(BuildContext context) {
var theme = Theme.of(context); var theme = Theme.of(context);
var chatUserDisplay = Wrap(
children: [
...chat!.users.map(
(tappedUser) => Padding(
padding: const EdgeInsets.only(
bottom: 8,
right: 8,
),
child: InkWell(
onTap: () {
onTapUser?.call(tappedUser);
},
child: Column(
mainAxisAlignment: MainAxisAlignment.start,
mainAxisSize: MainAxisSize.min,
children: [
FutureBuilder<UserModel>(
future: service.getUser(userId: tappedUser).first,
builder: (context, snapshot) {
if (snapshot.connectionState == ConnectionState.waiting) {
return const CircularProgressIndicator();
}
var user = snapshot.data;
if (user == null) {
return const SizedBox.shrink();
}
return options.builders.userAvatarBuilder?.call(
context,
user,
44,
) ??
Avatar(
boxfit: BoxFit.cover,
user: User(
firstName: user.firstName,
lastName: user.lastName,
imageUrl:
user.imageUrl != null || user.imageUrl != ""
? user.imageUrl
: null,
),
size: 60,
);
},
),
],
),
),
),
),
],
);
var targetUser = user ??
(
chat != null
? UserModel(
id: UniqueKey().toString(),
firstName: chat?.chatName,
imageUrl: chat?.imageUrl,
)
: UserModel(
id: UniqueKey().toString(),
firstName: options.translations.groupNameEmpty,
),
) as UserModel;
return Stack( return Stack(
children: [ children: [
ListView( ListView(
@ -145,20 +216,7 @@ class _Body extends StatelessWidget {
children: [ children: [
options.builders.userAvatarBuilder?.call( options.builders.userAvatarBuilder?.call(
context, context,
user ?? targetUser,
(
chat != null
? UserModel(
id: UniqueKey().toString(),
firstName: chat?.chatName,
imageUrl: chat?.imageUrl,
)
: UserModel(
id: UniqueKey().toString(),
firstName:
options.translations.groupNameEmpty,
),
) as UserModel,
60, 60,
) ?? ) ??
Avatar( Avatar(
@ -223,65 +281,7 @@ class _Body extends StatelessWidget {
const SizedBox( const SizedBox(
height: 12, height: 12,
), ),
Wrap( chatUserDisplay,
children: [
...chat!.users.map(
(tappedUser) => Padding(
padding: const EdgeInsets.only(
bottom: 8,
right: 8,
),
child: InkWell(
onTap: () {
onTapUser?.call(tappedUser);
},
child: Column(
mainAxisAlignment: MainAxisAlignment.start,
mainAxisSize: MainAxisSize.min,
children: [
FutureBuilder<UserModel>(
future: service
.getUser(userId: tappedUser)
.first,
builder: (context, snapshot) {
if (snapshot.connectionState ==
ConnectionState.waiting) {
return const CircularProgressIndicator();
}
var user = snapshot.data;
if (user == null) {
return const SizedBox.shrink();
}
return options.builders.userAvatarBuilder
?.call(
context,
user,
44,
) ??
Avatar(
boxfit: BoxFit.cover,
user: User(
firstName: user.firstName,
lastName: user.lastName,
imageUrl: user.imageUrl != null ||
user.imageUrl != ""
? user.imageUrl
: null,
),
size: 60,
);
},
),
],
),
),
),
),
],
),
], ],
), ),
), ),