myckhel/laravel-chat-system

Simple Laravel Chat Library

ChatSystem

This is where your description should go. Take a look at contributing.md to see a to do list.

Installation

Via Composer

$ composer require myckhel/laravel-chat-system

Documentaion

Documentaion

Postman Documentaion

Postman Documentaion

Examples

Laravel Inertia React

Demo

Source

Expo Snack

Demo

Usage

Change log

Please see the changelog for more information on what has changed recently.

Testing

$ composer test

Contributing

Please see contributing.md for details and a todolist.

Security

If you discover any security related issues, please email author email instead of using the issue tracker.

Credits

• Myckhel
• [Hernan Martinez Reumann][https://github.com/hmreumann]
• All Contributors

License

license. Please see the license file for more information.

laravel-chat-system's Issues

Write Tests with pestphp

Write Tests with pestphp

Add `type` column to conversation

Adding a type column would make the lib get prepared for group conversation support.

• type should be an enum with values [private, group, issue]
• type should be indexed
• type should have private as default

TODOS

• add type column to conversation migration
• update conversation model with type changes.

Create Interface for all models

This will enable to type hint values properly and ensures arguments types are the expected types

Given the example type hint below

use Myckhel\ChatSystem\Contracts\IConversation;

function deleteConversation(IConversation $conversation){
    $conversation->delete();
}

Models interfaces should be created to the directory /Contracts

• create Conversation Interface
• create Message Interface
• create Conversation User Interface
• create Chat Event Interface
• type hint methods referencing models

Add Support for Laravel 10

change service provider's publish config name from `chat-system.config` to `config`

Running php artisan vendor:publish --provider="Myckhel\ChatSystem\ChatSystemServiceProvider" --tag='config' per the doc: results in error: Unable to locate publishable resources.

Changing the name will fix.

Add Message User guide to docs

TODO

• [docs]: added user model setup guide 39e8711

Add metas column to Message

Replace Metas by adding metas column to Message model.

metas column schema: json

CheckList:

• add metas column to message
• delete Metas model, migration, trait and relationship
• remove metas config refs from chatsystem's config
• update MessageController@store token creation by using message.metas column to store token
• remove metas refs from MessageController@index

Rename methods that does not have proper meaning for their use cases

Create `conversation->addParticipant($user)` method

Notes*

• method should add the given user as a participants

• method should create a message of type = activity, message = '{User->name ?? "user"} joined the conversation'

• Create conversation->addParticipant($user, ?$activityMessage) method

• create POST conversations/{convasation}/join endpoint

• allow participant join conversation if not private type

Create `conversation->removeParticipant($user)` method

Notes*

• method should remove the given user as a participants

• method should create a message of type = activity, message = '{User->name ?? "user"} left the conversation'

• Create conversation->removeParticipant($user, ?$activityMessage) method

• create DELETE conversations/{convasation}/join endpoint

• allow participant leave conversation if not private type

Change Message broadcast event name to adapt to `laravel-echo`

Current Message broadcast event name is not compatible with laravel-echo.

Making it compatible may be a good idea.

Issue

Add conversation `isParticipant` property

Add isParticipant property to conversationController@index & @show response.
user is likely not to be a participant of the conversation.
adding the isParticipant will determine if the user is a participant of the conversation

PHP v8.1 support

Support php v8.1

Remove `Myckhel` from `namespace`

Removing Myckhel from the namespace will make the library user friendly.

Hopefully no issues will be encountered.

Document codes with comments

Add code comments for each functions with description, argument types and return types.

Message/Conversation Resources Cleanup

Delete Linked resources when both parties has deleted message/conversation.
i.e relations and medias

• create message deleted observe to check and delete resources if all parties have deleted
• create message deleted observe to check and delete resources if all parties have deleted

#6 (comment)

Dont load `migrations` by default

Prevent loading migrations by default to encourage users publish migration files and modify.

when user run php artisan migrate, automatically it applies to chatsystem migrations without the user publishing the migration files.

it would be a good idea to always encourage the users to publish migration files so that they can modify the migrations to their tastes.

so when user run php artisan migrate it wouldn't automatically applied to chatsystem migrations until user manually publish the migration files.

Class App\Models\User contains 1 abstract method and must therefore be declared abstract or implement the remaining methods (Myckhel\ChatSystem\Contracts\ChatEventMaker::chatEventMakers)

Hello how are you???
I tried to implement the
* Myckhel\ChatSystem\Contracts\ChatEventMaker contract, in User Model, but I got an error
* Class App\Models\User contains 1 abstract method and must therefore be declared abstract or implement the remaining methods (Myckhel\ChatSystem\Contracts\ChatEventMaker::chatEventMakers); How can i fix that???
* I noticed in the API that we need 3 variables (name, email and password) to connect, but I only use 2 variables (username and password).
* how i want to handle this too???
* I also tried ChatSystem Broadcast Events;

var current_username = "{{ Auth::user()->username }}";
var current_user = "{{ Auth::user()}}";
var userid = "{{ Auth::id() }}";

Echo.private(message-event.user+userid)
.listen('message', (event) => {
console.log(event)
})
I got Error
[01:12:34] - 9BEdhJIOfQvhZG32AAAE could not be authenticated to private-message-event.user.9
{
"message": "Myckhel\ChatSystem\Broadcasting\Chat\UserMessageChannel::join(): Argument #2 ($messagesUser) must be of type Myckhel\ChatSystem\Broadcasting\Chat\User, string given, called in /var/www/eglise.local/vendor/laravel/framework/src/Illuminate/Broadcasting/Broadcasters/Broadcaster.php on line 279",
"exception": "TypeError",
"file": "/var/www/eglise.local/vendor/myckhel/laravel-chat-system/src/Broadcasting/Chat/UserMessageChannel.php",
can you help me solve his errors please? Thank you!!!!!!!

Add `type` column to `message`

• type should be an enum with values [user, system, activity]
• type should be indexed
• type should have user as default

TODOS

• add type column to message migration
• update message model with type changes.

Improve api documentation at postman

Improve api docs at postman with more descriptions and syntax highlight.
🔗 Postman Link

task

Fix Inconsistent tests

Fix php v8.1 Deprecated methods

Fix:
Calling static trait method Myckhel\ChatSystem\Traits\Config::config is deprecated, it should only be called on a class using the trait in /Applications/XAMPP/xamppfiles/htdocs/laravel-chat-system-example/vendor/myckhel/laravel-chat-system/src/Events/Message/Created.php on line 27