Releases: Rainbow-CPaaS/Rainbow-Node-SDK
### SDK for Node.JS 1.63 - October 2019
3-Release SDK Breaking Changes
- Warning: Starting 2019, the LTS active version of Node.js migrated to version 12.x. This version of SDK Node.js is only compliant with this LTS version up to 10.x.
Consequently, you need to update your Node.js version to 10.x in order to use this release of the SDK Node.js.
API Breaking Changes
- none
API Changes
- none
Others Changes
- Fix Options.ts the start up service requested to start when it is not already present in default config.
- Add bubble.lastActivityDate property : Last activity date of the room (read only, set automatically on IM exchange)
- Add Message factory
- Add listenning of system's signals "SIGINT", "SIGQUIT", "SIGTERM" for automatic call of stop on the rainbow intance.
- Fix Makecall when the user doesn't have telephony.
- Fix value Contact.id and Contact._id were sometime not filled
- Reduce logs in dev mod
- Add Message factory
- Fix onDivertedEvent callback
- Fix some missing return when reject Promise.
- Remove unused singleton in RESTTelephony
- Refactor entering existing logs in services and in some other classes
### SDK for Node.JS 1.62 - September 2019
3-Release SDK Breaking Changes
- Warning: Starting January 2019, the LTS active version of Node.js migrated to version 10. This version of SDK Node.js is only compliant with this LTS active version.
Consequently, you need to update your Node.js version to 10.x in order to use this release of the SDK Node.js.
API Breaking Changes
- none
API Changes
- none
Others Changes
- Typescript improvement
- Fix issue when an http request failed with a no-JSON body.
- Add in the proxy section of option parameter :
secureProtocol: "SSLv3_method"
: The parameter to enable the SSL V3.
### SDK for Node.JS 1.61 - September 2019
3-Release SDK Breaking Changes
- Warning: Starting January 2019, the LTS active version of Node.js migrated to version 10. This version of SDK Node.js is only compliant with this LTS active version.
Consequently, you need to update your Node.js version to 10.x in order to use this release of the SDK Node.js.
API Breaking Changes
- none
API Changes
- none
Others Changes
- Update the logs to remove all people data.
- CRRAINB-7686 : Fix code for the 'read' receipt is sent automatically to the sender when the message is received.
- Add the ability to start services one by one. To avoid the calls to unnecessary pay API on server.
- Add event
rainbow_onconferenced
fired when a conference event is received.
### SDK for Node.JS 1.60 - August 2019
3-Release SDK Breaking Changes
- Warning: Starting January 2019, the LTS active version of Node.js migrated to version 10. This version of SDK Node.js is only compliant with this LTS active version.
Consequently, you need to update your Node.js version to 10.x in order to use this release of the SDK Node.js.
API Breaking Changes
- none
API Changes
- Update the "leaveBubble" method to unsubscribe form a bubble if not already unsubscribed the connected user. Else delete it from bubble.
Others Changes
- Add method getStatusForUser in Bubble class to get the status of a user in the bubble
- Fix file url in XMPPService::sendChatExistingFSMessage and XMPPService::sendChatExistingFSMessageToBubble methods
- Add method BubblesService::getStatusForConnectedUserInBubble to Get the status of the connected user in a bubble
- Fix ImsService::getMessageFromBubbleById method
- Add shortFileDescriptor property in message return by ImsService::getMessageFromBubbleById method
### SDK for Node.JS 1.59 - August 2019
3-Release SDK Breaking Changes
- Warning: Starting January 2019, the LTS active version of Node.js migrated to version 10. This version of SDK Node.js is only compliant with this LTS active version.
Consequently, you need to update your Node.js version to 10.x in order to use this release of the SDK Node.js.
API Breaking Changes
- none
API Changes
- none
Others Changes
- Add in AdminService the method to get all users for a given admin
- Update method BubblesService::unsubscribeContactFromBubble to send an event when the request to unsubscribe a user from a bubble succeed at end of the microservice call. Because sometimes the xmpp server does not send us the resulting event. So this event change will be sent twice time.
- Add options::im::sendMessageToConnectedUser option to allow SDK to send a message to it self.
- Add logs when an error occurred in XmppClient::send.
### SDK for Node.JS 1.58 - July 2019
3-Release SDK Breaking Changes
- Warning: Starting January 2019, the LTS active version of Node.js migrated to version 10. This version of SDK Node.js is only compliant with this LTS active version.
Consequently, you need to update your Node.js version to 10.x in order to use this release of the SDK Node.js.
API Breaking Changes
- none
API Changes
- Add correlatorData when makecall (TelephonyService::makeCall, TelephonyService::makeConsultationCall).
- Update in fileStorage::uploadFileToConversation method to upload a file by an simple file path in file parameter or by the object description of the file (previous existing behavior).
Others Changes
- Fix : event presence rainbow_oncontactpresencechanged when a contact in the roster is on phone.
- Fix : put the SDK to STOPPED state if "rainbow_xmppdisconnect" arrive and the reconnection is disabled.
- CRRAINB-6601 : Fix : Allows to make a second 3PCC RCC if the second call is allowed in profile.
- Add properties Call::deviceType, Call::deviceState, Call::cause, Call::jid, Call::Call.
- Fix getForwardStatus. Update of the URL to get it on server.
- Add TelephonyService::getActiveCalls to retrieve active Call.
- CRRAINB-6773: Update TelephonyService::getCalls method to return all the Calls.
- Add TelephonyService::getCallsSize method to get calls tab size. Warning do not use length on the getCalls method result because it is the last index id +1.
- Treat the Calls array cache in TelephonyService with the event received from server instead of doing the treatment when an API method is called.
- CRRAINB-6600 : Add treatment of the initiated event in telephonyEventHandler to raise a dialing event.
- CRRAINB-6600 : Add treatment of the conference event in telephonyEventHandler.
- Update telephonyEventHandler::getCall to parse more data from XMPP telephony event
- Add Favorites service (fetchAllFavorites, createFavorite, deleteFavorite)
- Add Favorites events (rainbow_onfavoritecreated, rainbow_onfavoritedeleted)
- Add Favorites doc
- Add conversations::deleteMessage to delete a message by sending an empty string in a correctedMessage
- Add shortFileDescriptor in message when ImsService::getMessageFromConversationById
### SDK for Node.JS 1.57 - June 2019
3-Release SDK Breaking Changes
- Warning: Starting January 2019, the LTS active version of Node.js migrated to version 10. This version of SDK Node.js is only compliant with this LTS active version.
Consequently, you need to update your Node.js version to 10.x in order to use this release of the SDK Node.js.
API Breaking Changes
- none
API Changes
- Rename event
rainbow_onownbubbledeleted
torainbow_onbubbledeleted
when a bubble is deleted.
Others Changes
- RQRAINB-1550 : Add AdminService::getContactInfos method to retrieve informations about a user (need to be loggued in as a admin)
- RQRAINB-1550 : Add userInfo1 and userInfo2 value in Contact but it can only be filled for the current user himself and AdminService::getContactInfos methods
- RQRAINB-1550 : Add AdminService::updateContactInfos : Set informations about a user (userInfo1, userInfo2, ...).
- RQRAINB-1585 : Fix use of ErrorManager index.js
- Update package.json "moment-duration-format": "^2.2.2" and npm audit fix
- RQRAINB-1627 : Update to latest typescript engine
### SDK for Node.JS 1.56 - May 2019
3-Release SDK Breaking Changes
- Warning: Starting January 2019, the LTS active version of Node.js migrated to version 10. This version of SDK Node.js is only compliant with this LTS active version.
Consequently, you need to update your Node.js version to 10.x in order to use this release of the SDK Node.js.
API Breaking Changes
- none
API Changes
- Refactor the channel's events to follow the event received from server :
- replace events
rainbow_channelcreated
,rainbow_channeldeleted
byrainbow_channelupdated
with akind
parameter (with also alabel
) - Add event
rainbow_channelusersubscription
with akind
parameter (with also alabel
)
- replace events
Others Changes
- Add TelephonyService::deflectCall method to deflect a call to an other telephone number
- Update TelephonyService doc.
- Fix XMPPService::sendChatExistingFSMessageToBubble with the right from value.
- Add event emitter in HttpService to raise event when token fail
- Fix json parse in HttpService, and treat token expiration
- Add mime-types lib to find file type.
- Fix issue RESTService::unsubscribeToChannel method
- Add uploadChannelAvatar deleteChannelAvatar methods to manbage the avatar of a channel.
- Add treatment of "channel-subscription" event
- Refactor BubblesService with a method addOrUpdateBubbleToCache to have bubbles in cache.
- Add method ChannelsService::subscribeToChannelById to Subscribe to a channel using its id
- Add method ChannelsService::updateChannel to Update a channel
- Fix new conversation in a Bubble event
- Add calllog API doc
- Refactor BubblesService::deleteBubble to not close the Bubble before the delete
- Add a BubblesService::closeAndDeleteBubble method to close and delete a Bubble (Previous behaviour of deleteBubble).
- Add guestMode property in Contact class : Indicated a user embedded in a chat or conference room, as guest, with limited rights until he finalizes his registration.
- Add openInviteId property in Contact class : The open invite ID of the user.
### SDK for Node.JS 1.55 - April 2019
3-Release SDK Breaking Changes
- Warning: Starting January 2019, the LTS active version of Node.js migrated to version 10. This version of SDK Node.js is only compliant with this LTS active version.
Consequently, you need to update your Node.js version to 10.x in order to use this release of the SDK Node.js.
API Breaking Changes
- none
API Changes
- Update ImsService::sendMessageToJidAnswer and XMPPService::sendChatMessage with a new parameter answeredMsg to allow to send a reply to a message
- Update ImsService::sendMessageToBubbleJidAnswer and XMPPService::sendChatMessageToBubble with a new parameter answeredMsg to allow to send a reply to a message
- Update conversationEventHandler to handle the conversation Events from server (create/update)
- Add ConversationsService::getConversationByDbId method to retrieve a conversation from the dbid identifier.
- fix ContactsService::getRosters to return the list of contacts
- Refactor ChannelsService to return the real Channel type in API/Events
- Refactor ChannelsService to use the return types
- Add
ChannelsService::fetchChannelsByFilter
method retrieve a channel by filter - Add ContactsService::getConnectedUser method to get the connected user information
- Add ChannelsService::updateChannelVisibility method to update a channel visibility (closed or company)
- Add ChannelsService::updateChannelVisibilityToPublic method to update a channel visibility to company (visible for users in that company)
- Add ChannelsService::updateChannelVisibilityToClosed method to update a channel visibility to closed (not visible by users)
- Add ChannelsService::updateChannelTopic method to update the description of the channel to update (max-length=255)
- Update AdminService::createUserInCompany to add the roles parameter when creating a user.
- Rename the method
ChannelsService::createPrivateChannel()
toChannelsService::CreateClosedChannel
- Rename the method
ChannelsService::deleteMessageFromChannel()
toChannelsService::deleteItemFromChannel
- Rename the method
ChannelsService::getMessagesFromChannel()
toChannelsService::fetchChannelItems
- Rename the method
ChannelsService::removeUsersFromChannel1()
toChannelsService::deleteUsersFromChannel
- Rename the method
ChannelsService::removeAllUsersFromChannel()
toChannelsService::deleteAllUsersFromChannel
- Rename the method
ChannelsService::getUsersFromChannel()
toChannelsService::fetchChannelUsers
- Rename the method
ChannelsService::getChannelById()
toChannelsService::fetchChannel
- Rename the method
ChannelsService::publishMessageToChannel()
toChannelsService::createItem
- Fix wrong
INCOMMING
spelling toINCOMING
,incomming
toincoming
,Incomming
toIncoming
- Rename the method
ChannelsService::getAllOwnedChannel()
toChannelsService::getAllOwnedChannels
- Rename the method
ChannelsService::getAllSubscribedChannel()
toChannelsService::getAllSubscribedChannels
Others Changes
- Update comments limitations => limits
- Explain isTyping in the "Chatting with Rainbow users" guide
- Reduce log for the XMPP ping.
### SDK for Node.JS 1.54 - March 2018
3-Release SDK Breaking Changes
- Warning: Starting January 2019, the LTS active version of Node.js migrated to version 10. This version of SDK Node.js is only compliant with this LTS active version.
Consequently, you need to update your Node.js version to 10.x in order to use this release of the SDK Node.js.
API Breaking Changes
- None.
API Changes
- Remove the
data
property layer in result ofadmin::createCompany
API method. Properties found before indata
are a now in root object. - Fix
admin::removeUserFromCompany
ro return the deletion result.
Others Changes
- Add CallLog service (typeScript sources) to get/delete the calllog history.
- Update doc about options provided at building the SDK object for the logs.
- Change the sources from javascript to typescript. But the delivery is still js.
- Fix the
conflict
error on xmpp socket when two rainbow node sdk login at the same time. - Add
admin::createTokenOnBehalf
method to ask Rainbow a token on behalf a user. You need this user password. - Add
user/password
in the Proxy settings. - Add In
Call
object the memberdeviceType
. It can be MAIN for the main device, and SECONDARY for the remote extension linked to it. It can be used when the eventrainbow_oncallupdated
is raised to seperate events. - Update
setBubbleCustomData
to wait for the bubble to be updated by the eventrainbow_bubblecustomDatachanged
, and else get the informations about bubble from server