@pusher/chatkit - npm Package Versions

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

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.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.