CHANGELOG.md

Changelog

This project adheres to Semantic Versioning Scheme

---

Unreleased

1.14.0

Additions

• The token provider constructor will now additionally accept functions for url, queryParams, and headers. Thanks zoozalp.

1.13.3

Changes

• Logs a warning if onMessageDeleted hook is passed to subscribeToRoom

1.13.2

Fixes

• A bug which would under certain circumstances cause calls to fetch users by ID to not be properly batched.

Additions

• A disableCursors option for subscribeToRoomMultipart which opts out of receiving other user's cursors.

1.13.1

Fixes

• Bump push-notifications-web version. This will return a descriptive error if an invalid service worker registration is given to the SDK.

1.13.0

Additions

• Bump pusher-platform-js version. No changes to the public interface.

1.12.1

Additions

• enablePushNotifications now takes showNotificationsTabOpen and showNotificationsTabClosed options which enable or disable notifications when there is a tab open or closed.

1.11.0

Additions

• Support for pushNotificationTitleOverride in createRoom and updateRoom methods.

1.10.0

Additions

• Enabling push notifications now also enables notifications when the application tab is open but hidden.
• enablePushNotifications takes an onClick callback which is fired when one of these notifications is clicked, and passed the relevant room ID.

Additions

• Support for pushNotificationTitleOverride in createRoom & updateRoom

1.9.2

Changes

• Bump lodash version for security patch.

1.9.1

Changes

• Internal improvements to web push notifications

1.9.0

Additions

• Support for user specified room IDs. Provide an id parameter to the createRoom method.

1.8.0

Additions

• Better error messages for web push integrations:
  • Log a warning when using an unsupported browser
  • Raise an exception with a more helpful error message when it is detected that the service worker is missing.

1.7.1

Fixes

• Bad pinned version of push notifications dependency

1.7.0

Additions

• Beta support for web push notifications (currently Chrome-only)

1.6.1

Fixes

• Check for non-null content (rather than falsy) in message parsing so that empty content doesn't throw an error

1.6.0

Additions

• Support the onMessageDeleted hook

1.5.0

Additions

• unreadCount and lastMessageAt properties on room objects which contain the number of unread messages and the timestamp of the most recent message in a room.

1.4.1

Additions

• Throw an error if file to attach doesn't have a size.

1.4.0

Additions

• Multipart messaging support: sendSimpleMessage, sendMultipartMessage, fetchMessagesMultipart, and subscribeToRoomMultipart all use the new multipart message format.

Deprications

• sendMessage, fetchMessages, and subscribeToRoom are depricated in favour of their multipart counterparts. They will be removed in a future major release.

1.3.2

Additions

• The TokenProvider now accepts a withCredentials option which it forwards to XMLHttpRequest internally. See here.

1.3.1

Fixes

• a race condition when subscribing to the same room twice in very quick succession
• buffer room events until all relevant subscriptions are complete

1.3.0

Changes

• On reconnection hooks will now be fired for events that were missed during disconnection.

Fixes

• Race condition between leaving a room and receiving the removed-from-room event (the latter will now always fire).
• Errors when unsubscribing while receiving an event.

1.2.2

• Update the @pusher/platform dependency to 0.16.0 and so reconnections are much more reliable now (thanks @albertopriore in particular for helping with debugging)

1.2.1

Changes

• The deletedAt field is populated on the room object (it will be undefined unless the room has been deleted)

1.2.0

Additions

• The message attachment object now has a name field

1.1.2

• Move the dependency pusher-platform to @pusher/platform

1.1.1

Fixes

• Reduce time taken to reconnect broken websocket connection (e.g. network change or plug pulled) on Chrome by 60 seconds.

1.1.0

Additions

• A customData option for createRoom and updateRoom
• A customData property on the room object throughout

1.0.5

Fixes

• Re-includes the react-native.js adapter in the published package.

1.0.4 - 2018-11-05

Fixes

• The users property on the room object.
• Subscribe to user's own presence state.

1.0.3

Changes

1.0.2

Changes

• The fetchRequired property on message attachments is no longer defined (fetch is never required any more, just use the provided link directly).

• The fetchAttachment method is removed from the current user object since it is never required.

• renames onNewMessage to onMessage

• onPresenceChanged replaces onUserCameOnline and onUserWentOffline. Takes parameters (state, user) -- where state is { current, previous } and current and previous are one of "online", "offline", or "unknown".

• Room memberships (the user property on rooms) are now available only after subscribing to a room. Attempting to access them before subscribing will throw an error.

• room IDs are now strings everywhere

0.7.18 - 2018-10-12

Changes

• Increased default connection timeout from 10 to 20 seconds
• Bump pusher-platform-js dependency to 0.15.2

0.7.17 - 2018-06-18

Changes

• Internal fix to ensure that the room is properly returned from leaveRoom. No external change.

0.7.16 - 2018-06-18

Additions

• The connection timeout introduced in 0.7.13 is configurable by passing connectionTimeout (milliseconds) to the ChatManager constructor.

0.7.14 - 2018-06-12

Changes

• Adds a disconnect method to ChatManager which disconnects a user from Chatkit.

0.7.13 - 2018-06-12

Changes

• Subscriptions will now time out after 5s if no initial state is received.

0.7.12 - 2018-04-30

Changes

• Uploads files to path scoped by user ID (no external change)

0.7.11 - 2018-04-30

Changes

• Batch set cursor requests (no external change)

0.7.9 - 2018-04-10

Additions

• De-duplicate user information requests.
• Send SDK info headers along with every request (version, platform, etc).

0.7.8 - 2018-04-04

Changes

• Remove the es build because it was causing problems with webpack. If we want to add it back later more investigation and testing will be required.

0.7.7 - 2018-04-03

Changes

• Point es.js to the es module build not the web build.

0.7.6 - 2018-04-03

Changes

• Fill in a sensible default for missing presence data so we don't have to explicitly check for undefined.
• Use ES5 syntax in es.js to satisfy create-react-app's build script.

0.7.5 - 2018-03-26

Changes

• type check the private option to updateRoom rather than casting, so that default is undefined not false.

0.7.4 - 2018-03-20

Additions

• es module build for named imports and tree shaking when consuming the SDK with rollup

0.7.3 - 2018-03-20

Changes

• removed getAllRooms from the current user. It only causes confusion. Anyone using getAllRooms can replace swap it out for something like the following:

// instead of this
currentUser.getAllRooms().then(allRooms => {
  doTheThing(allRooms)
})

// do this
currentUser.getJoinableRooms().then(joinable => {
  doTheThing(joinable.concat(currentUser.rooms))
})

0.7.2 - 2018-03-19

Changes

• Subobjects of the current user (Rooms, Users, etc) are now mutated instead of replaced, so any reference to a room will represent the up to date state of that room.

Fixes

• Remove chatty logs about requiring room membership after leaving a room

0.7.0 - 2018-03-13

This version represents a radical departure from 0.6.X. The interface is very different, and there's a good chance we'll miss some of the changes in this log. If something isn't working after migration, the best place to look first is probably the documentation.

Changes

• Methods with onSuccess, onFailure callbacks changed to return promises instead. e.g.

chatManager
  .connect()
  .then(currentUser => {})
  .catch(err => {})

• All methods take a single object parameter (see the documentation for details on each method's arguments)

• Delegates renamed to hooks throughout. e.g.

currentUser.subscribeToRoom({
  roomId,
  hooks: {
    onNewMessage: m => {},
  },
})

• Hooks all prefixed with on. e.g. onNewMessage, onUserStartedTyping

• cursorSet hook renamed to onNewCursor

• authContext.queryParams and authContext.headers both moved to the root options object in the token provider. e.g.

const tokenProvider = new TokenProvider({
  url: 'your.auth.url',
  queryParams: {
    someKey: someValue,
    ...
  },
  headers: {
    SomeHeader: 'some-value',
    ...
  }
})

• addUser and removeUser renamed to addUserToRoom and removeUserFromRoom

• methods that used to accept a Room object now accept a roomId. e.g.

instead of

currentUser.subscribeToRoom(myRoom, hooks) // WRONG

do

currentUser.subscribeToRoom({ roomId: myRoom.id, hooks })

• The behaviour of read cursors has changed: in particular cursors are now accessed via currentUser.readCursor and set with currentUser.setReadCursor. See the Read Cursors section of the documentation for details.

• Presence data is now accessable on any user object under user.presence. e.g.

const isOnline = user.presence.state === "online"

• All users that share a common room membership are accesable under currentUser.users, and all members of a room are accessable under room.users.

0.6.2 - 2018-02-05

Fixes

• Catch errors in cursors get request

0.6.1 - 2018-01-25

Fixes

• Made sure that the messageLimit argument in subscribeToRoom was being validated as a number.
• Ensured that the position argument in setCursor is a valid number.
• Throw an error if the userId isn't provided to the ChatManager.

0.6.0 - 2018-01-19

Changes

• Simplify typing indicator API
  • removed startedTypingIn and stoppedTypingIn methods
  • instead call isTypingIn as frequently as you like (rate limited by the SDK)
  • startedTyping and stoppedTyping are fired exactly once each per burst of typing

0.5.1 - 2018-01-16

Fixes

• Fixed fetchMessageFromRoom which wasn't passing along the values provided in the FetchRoomMessagesOptions parameter as query params. Thanks @apalmer0!

0.5.0 - 2018-01-09

Changes

• ChatManager takes a userId as a required option, TokenProvider no longer does. (ChatManager passes the user ID to the token provider internally before requesting a token.)

Additions

• RoomDelegate has a cursorSet callback, fired whenever a cursor is set in the given room.

• CurrentUser has a setCursor method, to set a cursor in a given room.

• The CurrentUser object now has a cursors property, which contains all the user's own cursors, mapped by room ID. This is guaranteed to be populated before room subscriptions succeed, so e.g. currentUser.cursors[roomId] can be used upon receiving messages to determine if they have been read already.

0.4.0 - 2018-01-04

Additions

• Add initial support for receiving cursors.

0.3.2 - 2017-12-19

Changes

• addMessage has been renamed to sendMessage and now expects a different set of parameters:

What previously would have been this:

currentUser.addMessage(
  "Hi there! 👋",
  myRoom,
  messageId => {
    console.log("Success!", messageId)
  },
  error => {
    console.log("Error", error)
  },
)

now needs to be written like this:

currentUser.sendMessage(
  {
    text: "Hey there!",
    roomId: myRoom.id,
  },
  messageId => {
    console.log("Success!", messageId)
  },
  error => {
    console.log("Error", error)
  },
)

Additions

• sendMessage supports adding an attachment to a message. See the docs for more information.

---

Older releases are not covered by this changelog.