podchat-browser/changelog.md

Javascript SDK to use POD's Chat Service - Browser Only

# Changelog

All notable changes to this project will be documented here.
to see complete list of changelog please visit [ChangeLog](http://gp.fanapsoft.ir/pod/pod-basic-sdk/chat-js-browser-sdk/-/blob/master/changelog.md)

## [Unreleased]

## [12.9.17] 23-08-2025

### Added

- Added optional in memory cache for getThreads
- Added optional in memory cache for getHistory
- Added cache for method getHistoryByMessageIdRange
- Added param archived to method getThreads
- Added new contact methods
- Integrated cache to new contacts api
- Added parameter forceConvert to method getImageFromPodspaceV2
- Added cache for NotSeenDuration
- Added method getUnreadMessagesCount
- Added method ExportThreadParticipants
- #call - Added call admin methods
- #call - Added additional raiseHand fields in server responses for better management of raiseHand state during the calls
- #call - Added errors for start/stop record
- #call - Fixed bug in error for method startScreenShare
- #call - Added default item for speaker in safari
- #call - Added possibility to access call streams instead of using tags
- #call - Added flag for stream change in call_divs
- #call - Added new CALL_CONNECTION_STATUS event for janus
- #call - Added event INQUIRY_CALL_RESULT in janus calls to fix ui with changes on user reconnects due to network problems
- #call - Added event YOU_DROPPED_FROM_CALL after reconnect

### Changed

- Fixed thread_leave_participant problems
- #call - Changed mute functionality, close track on request (Before server response)
- #call - Changed endCall handling to close call on request (before server response
- #call - ReWrite janus calls reconnect functionality
- #call - Added video permission check before sending request to server
- #call - Modified leave_call to only fire event when callId is same as current active call id
- #call - Added error code for camera stop error

### Fixed

- Fixed bug in event thread_leave_participant
- Fixed bug in canceling large files upload
- #call - Minor bugs in kurento calls
- #call - Fixed bug on call participant left
- #call - Prevent console error on method endCall

## [12.9.16] 07-01-2024

### Added
- Added event THREAD_PARTICIPANT_JOIN for type 39 (joinPublicThread)
- Added method to let client change stream in sdk
- Added uniqueId to all important call events (multitrack)

### Changed
- Added stream to grantUserMediaDevicesPermissions callback result
- Changed multitrack video to get video width from config
- Added deprecation warning in method changeActiveTypeCode

## [12.9.15] 04-12-2024

### Added
- Added threadId to reaction events
- Added configurable logger module in run-time
- Added retry and addUserToUserGroup on error 403 when downloading image
- Cache for threads history
- Added typeCode to all thread events

### Fixed
- Added check to prevent console errors on peer destroy
- Removed console log error in fireEvent method
- Prevent unnecessary request in type 244 (Reaction summaries) cache, after new message

### Changed
- Changed permission functionality on getDevicesList
- Changed hardcoded neshan map api key in neshan map link
- Refactored callDiv events
- Disabled deprecated callTurnIp in sdk config
- Removed unused package dexie
- Improvement on multitrack call reconnect
- Update PodSpace download image links
- Improved failure handler in janus calls


## [12.9.14] 10-09-2024

### Added
- Possibility to remember last chosen media device on changeMediaDevice functionality in calls
- New validations to prevent fire call messages when call not exists
- Field callId to all call events
- Stream to callEvents type CALL_DIVS
- Events for already existing functionality Archive and unArchive thread
- threadId to reactionsMethods
- Method: addParticipants2 with new possibility to add user and let them see history from specific time
- Added typeCode in new, edit, delete message events
- Added event GET_CALLS_TO_JOIN
- Added parameter typeCode to method seen
- Added chatMessageTypes 17, 18, 19

### Fixed
- Minor bug in build
- Minor bug in changeMediaDevice functionality
- UnHandeled exceptions on some call scenarios
- Improvements on janus calls
- Bug on moving to new call functionality
- Major bug fixes in multiple typeCode functionality
- REMOVE_ADMIN_ROLE result was incomplete

### Changed
- Refactored deviceManager access from outside
- Call requests blocking timeout

## [12.9.13] 07-07-2024

### Added
- UniqueId to async message for call messages
- Simple history cache
- Field reactionStatus to thread object
- Method getThreadAllowedReactions

### Fixed
- Minor bug fixes and improvements
- Fixed audio mic left open on some scenarios
- Fixed no label for media devices in firefox

### Changed
- Disabled auto sending delivery on sdk
- add CUSTOMIZE_REACTION event and refactor CUSTOMIZE_REACTION
- Update podasync-ws-only
- Refactored media device change functionality
- Refactored functionality of method grantUserMediaDevicesPermissions (Not backward compatible)

## [12.9.11]
## [12.9.10] 08-05-2024

### Added
- Method addUserToUserGroup
- Cache for contacts
- Search contacts locally when all contacts are previously loaded by user interaction
- Possibility to make calls with Janus-MultiTrack with auto-switching in SDK based on the call config from server
- Inquiry call participants internally in SDK, after user network failure and correct peers on MultiTrack
- Ability to upload files with posibility to resume the process after network failure
- Listed new reaction stickers
- Added peer status events to MultiTrack
- Added possibility to change input devices during the call process in MultiTrack

### Fixed
- Retry upload/download requests on error 403 from podspace
- Minor bug fixes

### Changed
- Modified way to access the current active call in SDK for future plans
- Moved contacts methods to a separate module

## [12.9.9] 31-01-2024

### Added
- Methods setRoleToUser/removeRoleFromUser
- field lastReactionVO to thread object
- cache for getPinMessages
- validation for appId
- Method lastActionInThread
- support for multiple typeCodes

### Fixed
- Incorrect parameter access in reactionSummaries
- Fixed errors in call message id: GET_KEY_FRAME
- Keyframe problems on start record
- Minor bug fixes
- Fixed name is blob from podspace

## [12.9.7] 25-11-2023

### Added
- Method replyPrivately
- Method replyFileMessagePrivately
- Method getThreadsLight
- Method getPinMessages
- Method lastMessageInfo
- Method addReaction
- Method removeReaction
- Method replaceReaction
- Method getReactionsSummaries
- cache for getReactionsSummaries
- Method getReactionsList
- cache for getReactionsList
- Ability to switch async protocols
- uniqueId for ping messages
- Parameter usernames to method removeParticipants
- xss check for messages contents
- requestBlocking for some call actions
- callId to REJECT_GROUP_CALL

### Fixed
- socketState 0 on event chatState was not being fired
- mute/unmute in calls causing performance bug in browsers
- screenShare cropped when sharing a non fullscreen window

### Changed
- Internal changes making the sdk more modular
- Rewrite call module

## [12.9.6] 29-07-2023
## [12.9.6-snapshot.4] 19-07-2023
## [12.9.6-snapshot.3] 19-07-2023
## [12.9.6-snapshot.2] 19-07-2023

### Added
- Implemented mode: auto switch between async protocols

### Fixed
- window is undefined error in Next.js projects
- Modified 31:LAST_SEEN_UPDATED unreadCount cache condition to prevent errors


## [12.9.6-snapshot.1] 11-07-2023

### Changed
- Update podasync-ws-only@2.9.0-snapshot.10


## [12.9.6-snapshot.0] 09-07-2023

### Changed
- Merge default count=25, offset=0
- Merge sdkParams in separate module

###Fixed
- Fixed store error for not loaded thread on type 31 (unreadCount cache)

## [12.9.5] 2023-07-09

### Changed
- remove old cache
- Modification on unreadCount cache to prevent unwanted higher unreadCount on event unread_count_updated

## [12.9.4] 2023-07-02

### Added
- Properties: metadata, systemMetadata to pinMessageVO in result of method getThread
- sample for deleteMultipleMessages
- Fix lastSeenMessageTime (19 Numbers) on type 31:LAST_SEEN_UPDATED
- timeNanos & Changed time (19 Numbers) in pinMessage

### Changed
- Changed cached unreadCount calculation on new messages

## [12.9.3] 2023-06-20
## [12.9.2] 2023-06-18 - deprecated

### Fixed
- Send threadId in event DELETE_THREAD


## [12.9.1] 2023-06-17

### Fixed
- Incorrect version number in runtime

## [12.9.0] 2023-06-12

### Added
- Properties: metadata, systemMetadata to pinMessageVO in result of method getThread

## [12.8.4] 2023-06-17

### Fixed
- Incorrect version number in runtime

## [12.8.3] 2023-06-12 - deprecated

### Added
- UnreadCount cache

## [12.7.2] 2023-06-12

### Added
- prevent request when socket not connected
- Event: THREAD_UNREAD_COUNT_UPDATED on chat: LAST_MESSAGE_DELETED
- Implemented new poor connection event for audio and video
- Method resetCallStream
- Event CALL_RECORDING_FAILED
- uniqueId to socket data
- Params: username, cellphoneNumber to method: getThreadParticipants
- Param: coreUserId to method: getContacts
- Param: onlyNewMessages to method: getHistory
- Params: isGroup, type to method: getThreads
- Prevent ringing in other devices of the call owner

### Changed
- Method shouldNotProcessChatMessage modified
- Method recallThreadParticipant modified
- Merge audioLevel improvements
- Update package async-ws-only
- Method exportChat modified due to the chat server changes
- Modified ping functionality with chat server
- Improved functionality of field: ownerId
- Removed unnecessary call to getAllThreads on asyncReady
- Modified process of call request handling functionality
- Merge: setToken improvement, sdk version

### Fixed
- Incorrect callId in some scenarios
- Bug in CALL_DIVS event in groupCall
- Bug, call participants voice was playing in other devices of the user

## [12.7.2-snapshot.30]
- Updated package podasync-ws-only to version 2.9.0-snapshot.4 to fix retryStep

## [12.7.2-snapshot.29]
- Rollback get user on each socket reconnect to previous functionality
- Updated package podasync-ws-only to fix retryStep

## [12.7.2-snapshot.28]
- Changes to not prevent get user info requests when chat is not ready (but async is ready) Which causes faster get user on reconnects

## [12.7.2-snapshot.27]
- Changed functionality to get user on each socket reconnect (Temporarily)
- Fixed functionality of method enableParticipantsVideoReceive (Was fixed in other versions and merged here)

## [12.7.2-snapshot.26]
- Added additional check to make sure SDK does well even if chat server sends participant instead of participantVO in new messages or history

## [12.7.2-snapshot.24]
- Fixed screenShare problem
- Consider the call as started when SDK receives 74:START_CALL event instead of waiting for response of CREATE_SESSION


## [12.7.2-snapshot.0] - 2022-11-01
### Added
- Added possibility to accept incoming call while user is in an existing call
- Check to prevent request when socket not connected

## [12.7.1] - 2022-10-29
### Added
- fire Event: THREAD_LAST_SEEN_UPDATED on chat message: LAST_SEEN_UPDATED, type: 31
- Retry requests to kurento
- Property: chatId to call requests
- Property: callId to event type: CALL_PARTICIPANT_LEFT
- Grant permissions internally in methods startCall, startGroupCall, acceptCall
- SDK parameter: typeCodeOwnerId
- Object: deviceManager
- Method: deviceManager.grantUserMediaDevicesPermissions
- Event type: SWITCH_TO_GROUP_CALL
- Possibility to know if we are the call starter
- Reset SDK internal data when starting a new call
- Event type: CALL_RECORDING_STARTED
- Property: callId to Event type: CALL_STARTED
- Parameters: fromTime, toTime in method: getThreads
- Method: sendCallSticker
- Method: getCustomerInfo
- Event: CONTACT_THREAD_UPDATE
- Methods: archiveThread/unArchiveThread
- Property: threadId to event: RECEIVE_CALL
- Method: recallThreadParticipant
- Property: seenByAnyAssistant to thread item
- Property: callCenter to userInfo

### Changed
- Do not process some chat messages when subjectId is not equal to current callId
- Retry the request instead of switching kurento
- Removed contentCount from hasNext calculation in getThreads and getHistory
- Modified LEAVE_CALL handling
- exportChat supports multiline texts and enhanced its exports for special chars
- Prevent duplicate call user in SDK on chat event CALL_PARTICIPANT_JOINED
- Modified ScreenShare functionality
- Modified video aspect ratio
- Prevent listing unused tags in CALL_DIVS event
- Removed Sentry from SDK
- Event: MESSAGE_DELETE, Added: time, timeNanos

### Fixed
- Resolved userInfo exception in podspace methods
- Error when callOptions is not received in SDK Params
- Bug in replyFileMessage
- Audio and Video problem after rejecting an incoming call


## [12.7.1-snapshot.22] - 2022-10-12
### Added
- fire Event: THREAD_LAST_SEEN_UPDATED on chat message: LAST_SEEN_UPDATED, type: 31

## [12.7.1-snapshot.21] - 2022-10-11
## [12.7.1-snapshot.20] - 2022-10-11
### Changed
- Event: MESSAGE_DELETE, Added: time, timeNanos

## [12.7.1-snapshot.19] - 2022-10-9
### Added
- Retry requests to kurento
- Property: chatId to call requests

### Changed
- Do nothing when leave call is not for current active call
- Method: sendCallMessage

## [12.7.1-snapshot.17] - 2022-10-1
### Fixed
- Bug in replyFileMessage

## [12.7.1-snapshot.16] - 2022-09-29
### Changed
- Modified recallThreadParticipant
### Fixed
- Error: userInfo is not defined in method uploadFileToPodspaceNew


## [12.7.1-snapshot.15] - 2022-09-12
### Added
- Property: seenByAnyAssistant to thread item
- Property: callCenter to userInfo
- Method: recallThreadParticipant
### Changed
- Improved sendCallMessage functionality
- Improved error logs in console
### Fixed
- Video not present in recording result in firefox

## [12.7.1-snapshot.14] - 2022-09-5
### Added
- Property: threadId to event: RECEIVE_CALL
- Method: recallThreadParticipant
### Changed
- Inform all thread participants of event: CALL_PARTICIPANT_LEFT
- Removed Sentry from SDK
- Improved request timeout mechanism in direct call message types requests
### Fixed
- Error when callOptions is not received in SDK Params
- Listing unused tags in CALL_DIVS event

## [12.7.1-snapshot.12] - 2022-08-21
### Added
- Event: CONTACT_THREAD_UPDATE
- Methods: archiveThread/unArchiveThread

## [12.7.1-snapshot.11] - 2022-08-16
### Added
- Method: getCustomerInfo

### Changed
- ScreenShare functionality
- Modified video aspect ratio
- Modified method: sendCallSticker

## [12.7.1-snapshot.9] - 2022-07-30
### Added
- Method: sendCallSticker

### Fixed
- Problem on CALL_ENDED didn't get fired for all thread participants
- Audio and Video problem after rejecting an incoming call

## [12.7.1-snapshot.8] - 2022-07-24
### Fixed
- Fixed bug on permission check error in call methods

## [12.7.1-snapshot.7] - 2022-07-23
### Changed
- Disabled healthCheck
- Prevent duplicate call user in SDK on chat event CALL_PARTICIPANT_JOINED
- Minor improvement 

## [12.7.1-snapshot.6] - 2022-07-20
### Added
- Parameters: fromTime, toTime in method: getThreads

### Changed
- exportChat supports multiline texts and enhanced its exports for special chars

### Fixed
- Bug in method acceptCall parameter cameraPaused didn't work after new changes
- Resolved userInfo exception in method uploadFileToPodspaceUserGroupNew

## [12.7.1-snapshot.5] - 2022-07-13
### Added
- Property: callId to event type: CALL_PARTICIPANT_LEFT
- Grant permissions internally in methods startCall, startGroupCall, acceptCall

### Changed
- Improved LEAVE_CALL handling

## [12.7.1-snapshot.4] - 2022-07-04
### Added
- Property: callId to event type: CALL_STARTED

### Changed
- Removed contentCount from hasNext calculation in getThreads and getHistory

## [12.7.1-snapshot.3] - 2022-07-04
### Added
- event type: CALL_RECORDING_STARTED

## [12.7.1-snapshot.2] - 2022-06-26
### Fixed
- bug in shouldNotProcessChatMessage

## [12.7.1-snapshot.1] - 2022-06-26
### Added
- SDK parameter: typeCodeOwnerId
- object: deviceManager
- method: deviceManager.grantUserMediaDevicesPermissions
- event type: SWITCH_TO_GROUP_CALL
- healthCehck for peer connections
- Possibility to know if we are the call starter
- Reset SDK internal data when starting a new call

### Changed
- Do not process some chat messages when subjectId is not equal to current callId
- Retry the request instead of switching kurento


## [12.6.0] - 2022-06-16
### Fixed
- User being muted when muting others
- Mute audio send only not all audio tags (Causes problems in Apple devices)

### Changed
- Improved call error logs in Sentry
- Update sentry url
- Update async package
- TypeCode handling functionality
- Updated sentry server URL
- Removed CALL_ENDED from LEAVE_CALL event in GroupCall

## [12.5.2-snapshot.7] - 2022-06-1
### Changed
- Removed CALL_ENDED from LEAVE_CALL event in GroupCall

## [12.5.2-snapshot.6] - 2022-05-31
### Fixed
- Mute audio send only not all audio tags (Causes problems in Apple devices)

## [12.5.2-snapshot.5] - 2022-05-29
### Fixed
-  User being muted when muting others

## [12.5.2-snapshot.4] - 2022-05-29
### Changed
- Improved call error logs in Sentry

## [12.5.2-snapshot.3] - 2022-05-24
### Changed
- Update sentry url


## [12.5.2-snapshot.2] - 2022-05-24
### Changed
- Update async package


## [12.5.2-snapshot.0] - 2022-05-24
### Changed
- Changed typeCode handling functionality
- Updated sentry server URL

## [12.5.1] - 2022-05-24
## [12.5.0] - 2022-05-24
### Added
- Config to timeout the call request
- Failover call turn servers
- Improved call process handling
- Event for new participant to detect call is being recorded
- Events for file download progress
- Changed resizeScreenShare
- Event to detect users are speaking in a call

### Changed
- Improved janus servers connectivity (internally)
- Refactored topic peers handling

### Fixed
- htmlElements is undefined
- screenShare bugs
- topic reconnect loop errors


## [12.3.1] - 2022-02-06
### Added
- Option to use internal turn address
- Event: RECEIVE_VIDEO_CONNECTION_ESTABLISHED
- Send keyframe on all video connections
- Parameter: threadId in method: getCallsList
- Implementation for reject group call
- Method: sendCallMetaData
- Method: getCallsToJoin
- Parameter: threadInfo in methods: startCall & startGroupCall
- Possibility to increase ScreenShare quality
- Possibility to join already existing group call
- Parameter: fileName in method exportChat

### Changed
- startCall & startGroupCall now support string in idType
- Refactored ScreenShare functionality

### Fixed
- Minor bug fixes
- Remove ScreenShare stream if it's owner leaves the group call

## [12.1.0] - 2021-12-25
### Added
- Browsers default "stop sharing" button event handler
- Sample to admin a user in a thread

### Fixed
- rejectCall in p2p calls
- exportChat result headers not readable

## [11.4.3] - 2021-12-13
### Added
- Poor Connection metadata


## [11.4.2] - 2021-12-13
### Added
- Call metadata


## [11.4.1] - 2021-12-12
### Added
- send key frame on start recording
- add participant to a p2p call

###Changed
- method: startGroupCall (Support for group call)
- Result format of exportChat

### Fixed
- startCall with invitees
- startGroupCall with invitees


## [11.3.4] - 2021-12-04

### Fixed
- Screenshare reconnect in current call
- Interval error when peer not fully connected

### Added
- Sample code of preventing async error when sending multiple file messages


## [4.10.0] - 2019-06-24

### Added

-   ACL functionalities
    - Getting admins list
    - Setting / Removing new admin with roles
-   `isTyping` for users, you can call `startTyping()` and `stopTyping()` to handle typing system messages
-   `clearHistory()` function to fully clear thread's history
-   `deleteMultipleMessages()` function to delete an array of message at once
-   `getNotSeenDuration()` function to get the time of user being off the application in miliseconds


## [3.5.38] - 2019-05-08

### Added

-   Function level cache control is now available. In order to disable receiving cache results for some specefic 
request, you can simply set `cache` parameter as `False` in `param` object which you're sending to chat SDK. 
Default value of `cache` is `True`. Be aware that this feature only works if global `enableCache` parameter has been set as `True`.
Below is the list of supported functions: 
    - `getHistory()`
    - `getThreads()`
    - `getThreadParticipants()`
    - `getContacts()`
    - `searchContacts()`
      
      
## [3.5.30] - 2019-04-28

### Added

-   Clear and Delete functionalities for cache. In order to clear current user's cache you can simply call `clearCacheDatabasesOfUser()` and if you want to delete whole cache database just call `deleteCacheDatabases()`

### Changed

-   Turn external web workers into Inline BLOB type workers.
-   Unified message structure for all queues


## [3.5.25] - 2019-03-13

### Added

-   Multi Tab IndexedDb CRUD management
-   `replyInfo` object now comes with `repliedToMessageTime`, `repliedToMessageTimeMiliSeconds` and `repliedToMessageTimeNanos`
-   `getHistory()` function now has 2 new parameters as below:
    - `queues` : This parameter takes an object as its value and declares which queues to be in return result of getHistory(). Default value for all 3 options is `TRUE`. Sample value object can be like below:
    ```javascript
    queues: {
        sending: true, 
        failed: false,
        uploading: true
    }
    ```
    - `dynamicHistoryCount` : If you need the number of messages that `getHistory()` function returns from server to be dynamically updated according to count of messages in message queues, you can set this parameter as `TRUE`. Default value is `FALSE`. 

### Changed

-   Cache return mechanism has changed. Here are all the details of each method:
    - `getThreads` : If there are some results for your request in cache, you'll get response from cache immediately. After receiving server's response, You'll get a new `threadEvents` event with `THREADS_LIST_CHANGE` type which gives you server's response. You can change your previous result with this one if you want to. Either way cache will update in background.
    - `getContacts` : Mechanism is the same as `getThreads`, the only difference is the event. After receiving server's response, You'll get a new `contactEvents` event with `CONTACTS_LIST_CHANGE` type which gives you server's response.
    - `getThreadParticipants` : Same as `getThreads`, but you will get a new `threadEvents` with `THREAD_PARTICIPANTS_LIST_CHANGE` type after server's response has received.
    - `getHistory`: If there are some results in cache for the request you made, we check some conditions on cache response, and if all goes well, we return from cache. Conditions are as below:
        - There should not be any GAPs between messages in cache result.
        - There should not be a GAP before first message of result.   
        
        If all the conditions pass, you get immediate response from cache. Then we wait for server to return it's response. After getting response from server, we check for differences between cache and server results and there we could have three scenarios:<br/> 
        -  There are some messages on server's result which were not in cache. in this case we emit a `MESSAGE_NEW` event to inform client of these new messages.
        -  Some messages have been deleted from server but we have them on cache. in this case we emit a `MESSAGE_DELETE` event.
        -  And if some messages have been edited on server, we simply return a `MESSAGE_EDIT` event.  
        
        If there are no messages on cache or one of conditions has failed, we will wait for server to return it's result and give it to client as callback result. <br/>  
        
-   The key for encrypting cache data now comes from server. If someone tries to decrypt user's cache with an invalid key, cache data will be automatically delete in order to keep user's data from being stolen. 
       

## [3.5.16] - 2019-01-28

### Added

-   `ActiveMQ` support has been added to `PodAsync`

In order to use `ActiveMQ` instead of `Websocket` you should send these parameters to `Chat()`

### ActiveMQ Parameters
```javascript
var params = {  
  protocol: "queue",
  queueHost: "172.16.0.248",
  queuePort: "61613",
  queueUsername: "root",
  queuePassword: "zalzalak",
  queueReceive: "queue-in-amjadi-stomp",
  queueSend: "queue-out-amjadi-stomp",
  queueConnectionTimeout: 20000
};
```

### Websockets Parameters

```javascript
var params = {
  socketAddress: "ws://172.16.106.26:8003/ws",
  serverName: "chat-server",
  wsConnectionWaitTime: 500,
  connectionRetryInterval: 5000,
  connectionCheckTimeout: 10000,
  reconnectOnClose: true
};
```

## [3.5.12] - 2019-01-22

### Changes

-   `block()` function has been changed and now you can block with `threadId`, `userId` alongside `contactId`

```javascript
chatAgent.block({
  contactId: 2247,
  // threadId: 1018,
  // userId: 121
}, function(result) {
  if (!result.hasError)
    console.log("Contact has been successfully Blocked!");
});
```

-   `unBlock()` function has been changed and now you can unblock with `contactId`, `threadId`, `userId` alongside `blockId`

```javascript
chatAgent.unblock({
  blockId: 425,
  // contactId: 2247,
  // threadId: 1018,
  // userId: 122
}, function(result) {
  if (!result.hasError)
    console.log("Contact has been successfully unBlocked!");
});
```

-   Thread model has been changed. `lastSeenMessageId`, `partnerLastSeenMessageId` and `partnerLastDeliveredMessageId` are no longer available, instead you can use below times:
    - `lastSeenMessageTime`
    - `partnerLastSeenMessageTime`
    - `partnerLastDeliveredMessageTime`


## [3.5.9] - 2019-01-20

### Added

-   `fromTimeFull` and `toTimeFull` have been added to `getHistory()` parameters. You can either enter full time as a 19 length number or enter it as `fromTime (length 13)` with `fromTimeNanos (length 9)`

```javascript
// Enter times like this
getHistoryParams = {
  fromTime: 1547896931323,
  fromTimeNanos: 323160000
}

// or like this
getHistoryParams = {
  fromTimeFull: 1547896931323160000
}
```

## [3.5.6] - 2019-01-19

### Changes

-   Refactoring Chat Send Queue and Upload Queue
-   `resendMessage()` now requires callbacks too.


## [3.5.3] - 2019-01-15

### Added

-   Cache synchronization with server to delete and update old cache data
    -   Update Cache on Message Delete/Edit
    -   Update Participants Cache
    -   Update Contacts Cache
    -   Update Threads Cache
-   Reply with file Message `replyFileMessage()`
-   Creating thread by sending or forwarding a message to someone
-   Set `image`, `description` and `metadata` parameters on thread creation so there would be no need for `updateThreadInfo()`
-   Implementing `UploadQueue`, `SendingQueue` and `WaitQueue` for chat messages
-   Resend `resendMessage()` / `cancelMessage()` Cancel function to handle failed messages
-   Cancel uploading and sending file messages with `cancelFileUpload()`
-   Get Message Delivered List `getMessageDeliveredList()`
-   Get Message Seen List `getMessageSeenList()`

### Changes

-   Update Chat ping mechanism
-   Replacing `RC4` with `AES` as encryption method


## [2.1.5] - 2018-11-17

### Changes

-   `replyInfo` has been changed as follow

```javascript
var replyInfo = {
  deleted,              /* Delete state of Replied Message */
  participant,          /* Sender of Replied Message */
  repliedToMessageId,   /* Id of Replied Message */
  message,              /* Content of Replied Message */
  messageType,          /* Type of Replied Message */
  metadata,             /* metadata of Replied Message */
  systemMetadata,       /* systemMetadata of Replied Message */
};
```

## [2.1.0] - 2018-11-13

### Added

-   `typeCode` attribute has been added to primary chat options. This attribute indicates which contact group you are willing to work with
-   `typeCode` is also available in every function separately and you can send this parameter along side others
-   You can declare type of message you are sending by setting `messageType` attribute. It takes an Integer value and you will get it on `getHistory()` results too.

### Changes

-   `notSeenDuration` attribute of `participants` will no longer save in cache, and you will get `undefined` in return

## [1.7.0] - 2018-11-06

### Added

-   Full cache support with local encryption for both Node and Browser Environments. In order to enable caching, you can set `enableCache: true` while you start a chat application
-   Embedded map services including
    -   `mapReverse()` which takes a Geo Location and returns its address back
    -   `mapSearch()` which takes a Geo Location and a Search term and returns an array of Nearby places containing that search term
    -   `mapRouting()` which takes two Geo Locations and returns the route between them
    -   `mapStaticImage()` which takes a Geo Locations and returns the static map image of that area


## [1.6.1] - 2018-10-21

### Added

-   Early version of Load Test are up now
-   `MESSAGE_DELETE` has been added to `messageEvents` listener, and whenever a message gets delete, you'll have an event announcing you that action. The result is like below:

```javascript
{ type: 'MESSAGE_DELETE',
  result: {
    message: {
      id: id_of_deleted_message,
      threadId: id_of_message_thread
    }
  }
}
```

## [1.6.0] - 2018-10-20

### Changes

-   `messageType` has been added to `MESSAGE` model
-   `admin` attribute has been added to `CONVERSATOIN` model
-   `contactId`, `contactName`, `contactFirstname`, `contactLastname` and `blocked` have been added to `PARTICIPANT` model

## [1.5.0] - 2018-10-10

### Added

-   If you want to grant device id from SSO you can set `grantDeviceIdFromSSO` as `TRUE` in initializing parameters


## [1.4.4] - 2018-10-01

### Changes

-   In order to rename a thread you can call `updateThreadInfo()` function and pass it 4 parameters as below:
    -   image
    -   description
    -   title
    -   metadata

-   `THREAD_INFO_UPDATED` events returns whole thread object

### Removed

-   `renameThread()` has been depreciated.

## [1.4.0] - 2018-08-27

### Added

-   Now you can Cancel File Uploads by calling `cancelFileUpload()` and sending file's uniqueId as a parameter to it

## [1.2.1] - 2018-08-27

### Added

-   `Block / unBlock` Functionality
-   `getBlockedList()` Function
-   `Spam` Functionality
-   Search in thread History and `metadata`
-   Update Thread Info
-   Search in Contacts list
-   `fileUploadEvents` Listener
-   Uploading progress for `File/Image Upload` and `sendFileMessage()`


## [1.1.5] - 2018-08-18

### Added

-   `getChatState()` Function
-   `TO_BE_USER_ID` type has been added to `inviteeVOidTypes` but only works while making P2P threads

### Changed

-   `PARTICIPANT` object now has `firstName` , `lastName` and `contactId` attributes
-   `image` attribute in `CONVRSATION` model changed to `lastParticipantImage`

## [0.7.6] - 2018-08-01

### Added

-   `setToken()` Function
-   `firstMessageId` and `lastMessageId` attributes in `getHistory()`

## [0.7.0] - 2018-07-22

### Added

-   Delete Message
-   Benchmark Tests

## [0.6.0] - 2018-07-16

### Added

-   Upload functionality for node base usages
-   Unit Tests (`npm test`)

## [0.5.1] - 2018-07-08

### Added

-   uploadImage
-   uploadFile
-   getImage
-   getFile
-   sendFileMessage

### Changes

-   npm version rescaled to 0.5.1 (Release . Sprint . Feature/Patch/BugFix)
-   MESSAGE_SEEN fires at Sender's side when he sends a SEEN type to server

## [3.9.8] - 2018-07-04

### Added

-   Add extra data on Message's metaData field and you will get your data back in metaData:{sdk: {}, user: { /**Your Custom Data Here**/ }}

### Changes

-   THREAD_LAST_ACTIVITY_TIME fires on sending message at Sender's side too


## [3.9.7] - 2018-07-04

### Added

-   threadEvents has 1 new type (Whatever happens in a thread, thread's time attribute changes. You can sort your list by listening to this event)
        \-   THREAD_LAST_ACTIVITY_TIME

## [3.9.6] - 2018-07-04

### Added

-   threadEvents has 1 new type (In case of someone remove you from an thread, you will get an event with this type containing the ThreadId you've been removed from)
        \-   THREAD_REMOVED_FROM


## [3.9.4] - 2018-07-04

### Added

-   You can Add Participants to an existing thread by addParticipants({threadId : Thread's ID, content : An Array of Contact IDs}, () => {});
-   To Remove participants from an thread use removeParticipants({threadId: Thread's ID, content: An Array of Participant IDs});
-   If you want to Leave a thread use leaveThread({threadId: Thread's Id}, () => {});
-   threadEvents now has 3 new types
    -   THREAD_ADD_PARTICIPANTS
    -   THREAD_REMOVE_PARTICIPANTS
    -   THREAD_LEAVE_PARTICIPANT


##[3.9.3] - 2018-07-04

### Added

-   messageEvents now has 2 new types
    -   MESSAGE_SEEN
    -   MESSAGE_DELIVERY

### Changed

-   messageEvents types get **MESSAGE\_** namespace and are as below:

    -   MESSAGE_NEW
    -   MESSAGE_EDIT
    -   MESSAGE_DELIVERY
    -   MESSAGE_SEEN

-   threadEvents types start with **THREAD\_**:
    -   THREAD_NEW
    -   THREAD_RENAME
    -   THREAD_MUTE
    -   THREAD_UNMUTE
    -   THREAD_INFO_UPDATED
    -   THREAD_UNREAD_COUNT_UPDATED


## [3.9.2] - 2018-07-03

### Added

-   2 main event listeners group (threadEvents, messageEvents)

    -   messageEvents has 2 types

        -   NEW_MESSAGE
        -   EDIT_MESSAGE

    -   threadEvents has 6 types
        -   NEW_THREAD
        -   THREAD_RENAME
        -   THREAD_MUTE
        -   THREAD_UNMUTE
        -   THREAD_INFO_UPDATED
        -   LAST_SEEN_UPDATED

### Removed

-   Below event listeners are no longer available :
    -   chatAgent.on("message", () => {});
    -   chatAgent.on("editMessage", () => {});
    -   chatAgent.on("newThread", () => {});
    -   chatAgent.on("threadInfoUpdated", () => {});
    -   chatAgent.on("threadRename", () => {});
    -   chatAgent.on("lastSeenUpdated", () => {});
    -   chatAgent.on("muteThread", () => {});
    -   chatAgent.on("unMuteThread", () => {});

## [3.9.1] - 2018-07-02

### Added

-   Contact Management (addContacts, updateContacts, removeContacts)
-   Search in Threads
-   Http Request Handler


### Changed

-   Received Seen & Delivery Messages now have {messageId, participantId} in response content