Firebase-chat-ready-api NPM

Firebase chat API 🔥

Firebase-chat-ready-API is a simple package enable fast connection to firebase firestore to create chat manager. Create chat rooms, send messages and listen to instance messages .

Getting started in a minute

Installation with

$ npm install firebase-chat-ready-api

Usage

This package have two main classes ChatRoom class and Message class as the ChatRoom class have properties and functions related to the whole chat room such as title, get messages, sending messages, etc ...
and the Message class have properties and functions related to individual message like message body, time of creation, update message, etc ...

First, import it

No ES6

const {
	initializeFirebase,
	ChatRoom
} = require("firebase-chat-ready-api");

ES6

import { initializeFirebase, ChatRoom } from "firebase-chat-ready-api";

Initialize the app

initializeFirebase({
	// your firebase app config...
});

Create chat room between two users

// define users objects
let userA = {userId: '1'} 
let userB = {userId: '2'}
// create chat room 
let newchatRoom = new ChatRoom("chat title", userA, userB, err => {
	if (!err) console.log(" chat room created successfully");
});

This class take 5 params as initial values

title the chat room title
userA one of the chat room members. object of {userId, username, photo}
userB second chat member. object of {userId, username, photo}
onComplete it's a callback function called after the chat room created successfully in firebase
fromRef create a class for chat room with it's firebase reference

Note: you can get created chat props also in the callback function through:
var newchatRoom = new ChatRoom("chat title", userA, userB, err => {
	// get the chat key
	if (!err) console.log(newchatRoom.chatRoomRef.key);
});

User Object is consists of

userId: the user unique id required
usename: username for this user not required
photo: url image for this user not required

Note: you can get all of title, members with their props and createdAt bt simply user the chat instance
newchatRoom.members[0].username;
newchatRoom.ctreatedAt;
...

Change the chat title

newchatRoom.setNewTitle("new title", title => {
	console.log("the chat new title is " + title);
});

This method is property of ChatRoom class. call with 2 params

title as a new string represent the new title
onComplete callback after changing the title passing the new title

Remove chat room

newchatRoom.remove();

This method is property of ChatRoom class. call with 2 params

softRemove set flag isRemoved to true
onComplete callback after removing the chat room

Remove mutual chat rooms between two users

ChatRoom.removeMutualChatRooms('userA Id', 'userB Id);

This method static function call with 2 params

userA The id of the user A
userB The id of the user B
softRemove set flag isRemoved to true

Send message in this chat room

You can use the ChatRoom instances to send messages to it.

var message = newchatRoom.sendMessage("Hi", userA, err => {
	if (!err) console.log("message sent");
});

This method also member of ChatRoom class. with 3 params

body string is the message body
from represent the user how send the message could be user Id or the user object
onComplete callback after sending the message to the firbase

this method is return Message instance

Get chat rooms related to user

ChatRoom.getUserChatRooms(userB, (err, chats) => {
	if (!err) console.log("Count of chats is :", chats.length);
	chats.map(chat => {
		console.log(chat.members[0].username);
	});
});

Note: This method is a static function

call with 2 params

user the user could be user Id or the user object
onComplete callback function call after receiving all chats from firebase passing 2 params
1. err is the error message if the call failed
2. chats it's an array ( List ) of all the user chat room (ChatRoom instances)

Get chat messages and listen for new messages comming

newchatRoom.getMessagesAndListen(message => {
	console.log(message.body);
});

call 1 params

action callback function is the action that should happen when receiving a message
Note : the massages come one after one not in list
This function fires after getting new message

Update message

message.updateBody("new message", newBody => {
	console.log("message text updated to" + newBody);
});

This method member of Message class

call with 2 params

newBody is the new updated message
onComplete callback after update

Remove message

var removedMessage = message.remove();

This method member of Message class

return the deleted message

call with 1 params

newMessage is the new updated message string
afterRemove callback after removing the message

You can get CreatedAt and updatedAt timestamps by message instance

console.log(message.createdAt);
// as the updatedAt property not available only after the message get updated
if (message.updatedAt) {
	console.log(message.updatedAt);
}

return timestamp as you can easily format it using package like moment (for more formats)

or by simply use Date Class

var date = new Date(createdAt);
// like: 4:01:50 AM
console.log(date.toLocaleTimeString());
// like: 10/16/2018
console.log(date.toLocaleDateString());
// like: 110/16/2018, 4:01:50 AM
console.log(date.toLocaleString());

createdAt property available also in ChatRoom instance

You can get also the chat room firebase reference(ref) and key. Like this :

var reference = newchatRoom.chatRoomRef;
var key = newchatRoom.chatRoomRef.key;

as newchatRoom is an instance of ChatRoom Class

Find chat by key (uid)

static function

ChatRoom.findById("-LPK1Rr5mzwkuSDV9U9a", (err, chat) => {
	if (!err) console.log(chat);
});

call with 2 params

uid chat unique id (key)
onComplete callback function call after receiving all chats from firebase passing 2 params
1. err is the error message if the call failed
2. chat chat room (ChatRoom instance)

Tests

Tests are using Jest, to run the tests add your firebase config object in the test file and run:

$ npm test

Roadmap

Check out our roadmap to get informed by the latest feature released and the upcoming ones. You can also give us insights and vote for a specific feature. And your are more than welcome to contribute.