From 9aec1899ba42cac92a9aa32d6c55b5be563ffcb9 Mon Sep 17 00:00:00 2001 From: dhyash-simform Date: Tue, 13 May 2025 15:32:11 +0530 Subject: [PATCH] chore: :truck: rename package to chatview_utils --- README.md | 11 ++++++++--- example/main.dart | 12 ++++++------ example/pubspec.yaml | 2 +- lib/{chatview_utility.dart => chatview_utils.dart} | 2 +- lib/src/models/data_models/chat_user.dart | 2 +- lib/src/models/data_models/message.dart | 4 ++-- lib/src/models/data_models/reply_message.dart | 2 +- lib/src/values/enumeration.dart | 10 +++++----- pubspec.yaml | 8 ++++---- 9 files changed, 29 insertions(+), 24 deletions(-) rename lib/{chatview_utility.dart => chatview_utils.dart} (87%) diff --git a/README.md b/README.md index 4f4beb3..640320a 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,16 @@ -# ChatView Utility +# ChatView Utils -[![Build](https://github.com/SimformSolutionsPvtLtd/chatview_utility/actions/workflows/flutter.yaml/badge.svg?branch=master)](https://github.com/SimformSolutionsPvtLtd/chatview_utility/actions) [![chatview_utility](https://img.shields.io/pub/v/chatview_utility?label=chatview_utility)](https://pub.dev/packages/chatview_utility) +[![Build](https://github.com/SimformSolutionsPvtLtd/chatview_utils/actions/workflows/flutter.yaml/badge.svg?branch=master)](https://github.com/SimformSolutionsPvtLtd/chatview_utils/actions) [![chatview_utils](https://img.shields.io/pub/v/chatview_utils?label=chatview_utils)](https://pub.dev/packages/chatview_utils) This is a utility library for the [chatview](https://pub.dev/packages/chatview) -and [chatview_db_connection](https://pub.dev/packages/chatview_db_connection) libraries, containing +and [chatview_connect](https://pub.dev/packages/chatview_connect) libraries, containing shared type declarations. It should not be used directly. +_Check out other amazing +open-source [Flutter libraries](https://simform-flutter-packages.web.app) +and [Mobile libraries](https://github.com/SimformSolutionsPvtLtd/Awesome-Mobile-Libraries) developed +by Simform Solutions!_ + ## License [MIT](LICENSE) \ No newline at end of file diff --git a/example/main.dart b/example/main.dart index e401ea2..28534dd 100644 --- a/example/main.dart +++ b/example/main.dart @@ -1,6 +1,6 @@ import 'dart:developer'; -import 'package:chatview_utility/chatview_utility.dart'; +import 'package:chatview_utils/chatview_utils.dart'; void main() { // Create sample users @@ -10,7 +10,7 @@ void main() { profilePhoto: Constants.profileImage, ); - log(currentUser.toString(), name: 'ChatView Utility'); + log(currentUser.toString(), name: 'ChatView Utils'); const otherUsers = [ ChatUser( @@ -20,7 +20,7 @@ void main() { ), ]; - log(otherUsers.map((e) => e.toString()).toString(), name: 'ChatView Utility'); + log(otherUsers.map((e) => e.toString()).toString(), name: 'ChatView Utils'); // Create some initial messages final messages = [ @@ -40,7 +40,7 @@ void main() { ), ]; - log(messages.map((e) => e.toString()).toString(), name: 'ChatView Utility'); + log(messages.map((e) => e.toString()).toString(), name: 'ChatView Utils'); // Demonstrate reaction final reaction = Reaction( @@ -48,7 +48,7 @@ void main() { reactions: ['👍'], ); - log(reaction.toString(), name: 'ChatView Utility'); + log(reaction.toString(), name: 'ChatView Utils'); // Demonstrate reply final replyMessage = Message( @@ -65,5 +65,5 @@ void main() { replyBy: currentUser.id, ), ); - log(replyMessage.toString(), name: 'ChatView Utility'); + log(replyMessage.toString(), name: 'ChatView Utils'); } diff --git a/example/pubspec.yaml b/example/pubspec.yaml index 43db10f..70e67d2 100644 --- a/example/pubspec.yaml +++ b/example/pubspec.yaml @@ -31,7 +31,7 @@ dependencies: flutter: sdk: flutter - chatview_utility: + chatview_utils: path: .. dev_dependencies: diff --git a/lib/chatview_utility.dart b/lib/chatview_utils.dart similarity index 87% rename from lib/chatview_utility.dart rename to lib/chatview_utils.dart index ae1e812..c066677 100644 --- a/lib/chatview_utility.dart +++ b/lib/chatview_utils.dart @@ -1,4 +1,4 @@ -library chatview_utility; +library chatview_utils; export 'src/controller/chat_controller.dart'; export 'src/models/models.dart'; diff --git a/lib/src/models/data_models/chat_user.dart b/lib/src/models/data_models/chat_user.dart index 05f0e71..74bd489 100644 --- a/lib/src/models/data_models/chat_user.dart +++ b/lib/src/models/data_models/chat_user.dart @@ -78,7 +78,7 @@ class ChatUser { /// Field to define image type. /// - /// {@macro chatview_utility.enumeration.ImageType} + /// {@macro chatview_utils.enumeration.ImageType} final ImageType imageType; /// Error builder to build error widget for asset image diff --git a/lib/src/models/data_models/message.dart b/lib/src/models/data_models/message.dart index 40cb6dc..9bd3c13 100644 --- a/lib/src/models/data_models/message.dart +++ b/lib/src/models/data_models/message.dart @@ -107,7 +107,7 @@ class Message { /// Represents the type of message. /// - /// {@macro chatview_utility.enumeration.MessageType} + /// {@macro chatview_utils.enumeration.MessageType} final MessageType messageType; final DateTime? updateAt; @@ -122,7 +122,7 @@ class Message { /// Provides message's current status. /// - /// {@macro chatview_utility.enumeration.MessageStatus} + /// {@macro chatview_utils.enumeration.MessageStatus} MessageStatus get status => _status.value; /// A [ValueListenable] for [MessageStatus] that notifies listeners diff --git a/lib/src/models/data_models/reply_message.dart b/lib/src/models/data_models/reply_message.dart index 2e1cdc3..125b403 100644 --- a/lib/src/models/data_models/reply_message.dart +++ b/lib/src/models/data_models/reply_message.dart @@ -56,7 +56,7 @@ class ReplyMessage { /// Represents the type of reply message. /// - /// {@macro chatview_utility.enumeration.MessageType} + /// {@macro chatview_utils.enumeration.MessageType} final MessageType messageType; /// Provides max duration for recorded voice message. diff --git a/lib/src/values/enumeration.dart b/lib/src/values/enumeration.dart index d4ae551..d590d5c 100644 --- a/lib/src/values/enumeration.dart +++ b/lib/src/values/enumeration.dart @@ -20,7 +20,7 @@ * SOFTWARE. */ -/// {@template chatview_utility.enumeration.MessageType} +/// {@template chatview_utils.enumeration.MessageType} /// Defines the various message types in ChatView. /// - [image]: An image message. /// - [text]: A text message. @@ -59,7 +59,7 @@ enum MessageType { } } -/// {@template chatview_utility.enumeration.TypeWriterStatus} +/// {@template chatview_utils.enumeration.TypeWriterStatus} /// Indicates whether the user is currently typing or has finished typing. /// - [typing]: User is still typing. /// - [typed]: User has completed typing. @@ -73,7 +73,7 @@ enum TypeWriterStatus { bool get isTyped => this == typed; } -/// {@template chatview_utility.enumeration.MessageStatus} +/// {@template chatview_utils.enumeration.MessageStatus} /// Represents the current state of a message from sending to delivery. /// - [read]: Opened by the recipient. /// - [delivered]: Successfully delivered. @@ -110,7 +110,7 @@ enum MessageStatus { } } -/// {@template chatview_utility.enumeration.ImageType} +/// {@template chatview_utils.enumeration.ImageType} /// Defines the different types of image sources. /// - [asset]: Image from local assets. /// - [network]: Image from a network URL. @@ -141,7 +141,7 @@ enum ImageType { } } -/// {@template chatview_utility.enumeration.ChatViewState} +/// {@template chatview_utils.enumeration.ChatViewState} /// Represents the different states of the chat view. /// - [hasMessages]: Chat has messages to display. /// - [noData]: No messages available. diff --git a/pubspec.yaml b/pubspec.yaml index c760811..101351d 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -1,8 +1,8 @@ -name: chatview_utility -description: Utility library for the chatview and chatview_db_connection libraries, containing shared type declarations. It should not be used directly. +name: chatview_utils +description: Utility library for the chatview and chatview_connect libraries, containing shared type declarations. It should not be used directly. version: 0.0.1 -repository: https://github.com/SimformSolutionsPvtLtd/chatview_utility -issue_tracker: https://github.com/SimformSolutionsPvtLtd/chatview_utility/issues +repository: https://github.com/SimformSolutionsPvtLtd/chatview_utils +issue_tracker: https://github.com/SimformSolutionsPvtLtd/chatview_utils/issues environment: sdk: '>=3.4.0 <4.0.0'