tigerconnect - npm Package Versions

[7.7.0] - 2019-10-24

General Changes

• events.connect():
  • The contract has been changed to not return a Promise.
  • The connection should be recovered more quickly after the computer goes offline, and will no longer emit console.log messages when this happens.

Polyfills

• If you are using automatically-installed polyfills:
  • The number of polyfills has been reduced to the minimum set that is used by the SDK.
  • Feel free to review the Polyfills section of the Installation docs for details on the exact polyfills which are automatically included.
• If you are using manually-specified polyfills:
  • The SDK will now throw an error if the right polyfills have not been provided.
  • Please review the Polyfills section of the Installation docs for details on the exact polyfills which should be included.

Fixes

• Fix issue where conversations.markAsDelivered() call may fail with 400 status.
• conversations.fetchTimeline():
  • Fix timing issue where new messages did not appear in conversation.timeline until the second time the function is called.
• conversations.selectConversation():
  • The minItemsToFetch parameter now works as the documentation describes.
  • Fix timing issue where new messages did not appear in conversation.timeline until the second time the function is called.
• In the Organization model:
  • organization.conversations will sometimes be sorted incorrectly, due to the conversation having an incorrect highestSortNumber value.
  • Messages sent to a broadcast list may cause an invalid lastMessage object to be provided in any 1-on-1 conversations with users who are in that broadcast list.
  • The lastMessage field will sometimes be missing or contain a message which is not the last message in that conversation.
• Fix issue where after a user joins a private group, full conversation history was shown from before the user had joined.
• Fix several issues around messages sent while the user has Do-Not-Disturb Auto-forwarding enabled

Known Issues

The following issues are present in this SDK release and are planned to be fixed in an upcoming SDK or Platform release:

• In conversations.fetchTimeline() and conversations.selectConversation():
  • Messages sent by the current user sometimes do not appear in conversation.timeline.
• In the Conversation model:
  • firstUnreadMessage will have an incorrect value in some situations
  • isUnread will have an incorrect value in some situations
  • highestSortNumber will have an incorrect value in some situations
  • unreadMessageCount will have an incorrect value in some situations

Documentation Updates

• Add Do Not Disturb page which explains the different kinds of Do-Not-Disturb functionality that are available.

[7.3.1] - 2019-09-30

Overview

• Extensive SDK documentation is now available at https://tigerconnect.github.io/js-sdk/, which includes Quickstart guides for Android SDK, iOS SDK, and JS SDK, along with further reference material for the JS SDK.
• It is recommended to review this documentation, since many JS SDK calls have changed since the last SDK release. Many of these changes are a result of the items listed in the "Performance Improvements" section below.
• The release repository has been moved to https://github.com/tigerconnect/js-sdk.
• Support for the following features has been implemented but not yet fully documented. Please contact your TigerConnect support representative for further information and pricing plans for these features.
  • Roles and Role Tags
  • Role Escalations
  • EHR Connect

Performance Improvements

• The JS SDK will no longer download every message when executing events.connect(), which will signficantly improve application load performance. Please read https://tigerconnect.github.io/js-sdk/quickstart/js/getting-inbox for further details.
• Message expiration is now implemented more performantly, and will no longer cause lag to user input (such as typing messages) in IE 11.
• Many other performance improvements have been implemented throughout the SDK based on feedback from customers who utilize the TigerConnect Messenger website at https://login.tigerconnect.com/app/messenger/index.html.

General Changes

• Breaking change: It is now required to pass partnerName as a config setting during new TigerConnect.Client() calls. It's recommended to pass version as well. Please contact your TigerConnect support representative to determine the correct value of partnerName for your SDK integration.
• Breaking change: The .off() method has been removed from anything which has an .on() method; use .removeListener() instead of .off()
• The SDK will now automatically sign out when the browser window is closed.
• client.messages.send() and client.messages.forward() will now use firstName instead of displayName of initial group members when creating new groups without a predefined group name.
• The includeMetadata option has been removed from client.search.query(). Metadata will now always be returned.
• The client.user.find() command has been modified to accept an optional organizationId parameter. It is recommended to always supply that parameter.

Offline Notifications

• The client.notifications API implements offline notifications, and is intended to be used as an optional feature while the user is logged out due to inactivity.
• While connected, this API emits events containing anonymized message content and unread counts which are suitable for displaying in operating system notifications or browser notifications.
• This API is used internally by the TigerConnect Desktop App.
• Documentation has not yet been written for this API. Please contact your TigerConnect support representative if you are interested in using it.

Known Issues

The following issues are present in this SDK release and are planned to be fixed in an upcoming SDK or Platform release:

• conversations.fetchTimeline():
  • The markAsDelivered parameter is ignored, and the fetched messages will always be marked as Delivered. Please contact your TigerConnect support representative if you are interested in being able to fetch messages without automatically marking them as Delivered.
  • There may be a timing issue where new messages do not appear in conversation.timeline until the second time the function is called.
• conversations.selectConversation():
  • The markAsDelivered parameter is ignored, and the fetched messages will always be marked as Delivered. Please contact your TigerConnect support representative if you are interested in being able to fetch messages without automatically marking them as Delivered.
  • The minItemsToFetch parameter does not yet work as the documentation describes, and will effectively always be 20. This will be fixed in the next SDK release.
  • There may be a timing issue where new messages do not appear in conversation.timeline until the second time the function is called.
• conversations.markAsDelivered():
  • This call may fail with 400 status. The issue will be fixed in a near-future SDK release.
• In the Conversation model:
  • firstUnreadMessage will have an incorrect value in some situations
  • isUnread will have an incorrect value in some situations
  • highestSortNumber is sometimes incorrect when adding a user to an existing group
• In the Organization model:
  • organization.conversations will sometimes be sorted incorrectly, due to the conversation having an incorrect highestSortNumber value.
  • Messages sent to a broadcast list may cause an invalid lastMessage object to be provided in any 1-on-1 conversations with users who are in that broadcast list.
  • The lastMessage field will sometimes be missing or contain a message which is not the last message in that conversation.
• When a user joins a private group, full conversation history is shown from before the user has joined, but it should only show the messages sent while the user is part of the group.
• Messages sent while the user has Do-Not-Disturb Auto-forwarding enabled:
  • Will not be sent to the auto-forward recipient
  • Will not cause an auto-reply message to be sent back to the original sender of the message
  • May cause an error to be logged to the JS console
• More polyfills are installed than are actually required by the JS SDK; this will be reduced in the next SDK release

[3.0.1] - 2017-08-15

• Fix some dependencies that are used in the nodejs bundle of this module.
• Improve the speed of running npm install on this module.

[3.0.0] - 2017-08-15

• Breaking change: Run browserUnload event hooks during window unload handler instead of beforeunload handler so that UI code can trap beforeunload to prompt the user with an alert if it needs to.
• client.messages.previewMessage() now preserves the value of statusesPerRecipient from the original message.
• A maximum of 50 messages will be ACK'd each second to ensure even load distribution to individual server nodes.
• A maximum of 2 connections will be allowed to send ACK payloads, as an additional precaution to ensure that messages can be sent quickly without tying up too many network connections to the server.
• client.messages.downloadAttachment() may now be called more than once to download the same attachment again.

[2.0.5] - 2017-07-26

• Debounce client.typingStatus.startTyping() and client.typingStatus.stopTyping() calls to the server with a 2-second window.
• This should address an issue with messages not being sent because the browser is stuck queueing many startTyping calls.

[2.0.4] - 2017-07-19

• Suppress type error when using undefined as an argument to client.typingStatus.startTyping() and client.typingStatus.stopTyping().

[2.0.3] - 2017-07-18

• Add displayName field to organization object. This will transform 'TigerText Customer' into 'Contacts'.
• Document client.messages.retrySend() API endpoint for safely re-attempting to send a failed message without duplication.

[2.0.2] - 2017-07-11

• Work around Selenium on Firefox issue which would cause finding selectors to be blocked.