smk-chat/docs.md

# Docs for smk-chat
## API
### /api/getCredentialsById/:userId

IN: _userId_ (in route)

OUT: _lastname_, _firstname_, _middlename_

Return credentials of the user whose id is userId.

Return -1 if no such user exist.

Requires client to be logged in.

### /api/getIdByCredentials
IN: _lastname_, _firstname_, _middlename_

OUT: _UserID_

Returns an ID of the user, whose lastname, firstname and middlename were passed.

Returns -1 if user does not exist.

Requires client to be logged in.

### /api/getMessagesFromChat/by-amount
IN: _chatId_, _amount_

OUT: array of objects that represent a message, like {"author_id": ..., time_sent: ..., content: ...}

Returns an array of last _amount_ ordered by date of described objects if everything is okay

Returns HTTP/1.1 400 "Chat with id _ID_ does not exist." if no chat with supplied id does not exist.

Returns HTTP/1.1 403 "You are not a member of this chat" if the statement is true ;)

Requires client to be logged in.

### /api/getMessagesFromChat/by-time
IN: _chatId_, _fromTimestamp_, _toTimestamp_

OUT: array of objects that represent a message, like {"author_id": ..., time_sent: ..., content: ...}

_fromTimestamp_ must be lower that _toTimestamp_, otherwise it might return nothing.

Returns an array of described objects if everything is okay

Returns HTTP/1.1 400 "Chat with id _ID_ does not exist." if no chat with supplied id does not exist.

Returns HTTP/1.1 200 and an empty string if no messages in chat are found /shrug.

Requires client to be logged in.

### /api/getChats
IN: _UserID_

OUT: Array of chat IDs

Returs an array with ids of chats which user with passed ID is member in.

Return empty string if user has no membership in any chat.

Requires client to be logged in.

### /api/getChatInfo/:chatId
IN: _chatId_ (in route)

OUT: JSON describes a chat with id: {name: ..., admins: ..., members: ...}

Note: JSON does not include messages. You have to use __/api/getMessagesFromChat__ to query messages.

Returns aforementioned json if the chat exists and user is a member of this chat.

Returns -1 if chat does not exist

Return -2 if user is not a member of the chat

Requires client to be logged in.

### /api/createChat
IN: _UserId_, array of UserIDs that are to be invited.

OUT: "Ok" if successful, "User with id _MEMBERID_ does not exist."

Return -1 if amout of users to invite is 0.

Requires client to be logged in

### /api/logout
IN: none.

OUT: redirect to __/login__.

Removes client's session, thus unlogging a user.

Requires client to be logged in.

### /api/register
IN: _lastname_, _firstname_, _middlename_, _password_

OUT: redirect to __/__

Checks if user exist. If so, returns 400 with response "Such user exists.".

Otherwise, registers a user with given data.

Requires clinet to be not logged in.

### /api/login
IN: _lastname_, _firstname_, _middlename_, _password_

OUT: redirect to __/__

Checks if user exists. If not, returns 400 with response "No such user.".

Otherwise, compares passwords

If passwords match, creating session and redirects to __/__

Requires client to be not logged in.


## Deployment
### Traditional
To deploy an application in traditional way, follow these steps:

1. edit ``config.json`` to your needs.

2. Install dependencies: ``npm i``

3. Run __src/index.js__. Use ``npm run prod`` if you want to run it as a production and ``npm run dev`` if you want to run it with nodemon.

### Docker
To deploy an application with Docker, you need to:

1.  edit ``config.json`` to your needs ( do not forget that backend must be able to connect to db container.)

2. edit ``docker-compose.yml`` as with the data you've wrote to ``config.json``

3. Build and launch: ``docker-compose up --build``