changelog, 0.7.0

Author: callum-oakley

CHANGELOG.md

@@ -4,7 +4,95 @@ This project adheres to [Semantic Versioning Scheme](http://semver.org)
 
 ---
 
-## [Unreleased](https://github.com/pusher/chatkit-client-js/compare/0.6.2...HEAD)
+## [Unreleased](https://github.com/pusher/chatkit-client-js/compare/0.7.0...HEAD)
+
+## 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](https://docs.pusher.com/chatkit/reference/javascript).
+
+### Changes
+
+- Methods with `onSuccess`, `onFailure` callbacks changed to return promises
+  instead. e.g.
+
+```javascript
+chatManager
+  .connect()
+  .then(currentUser => {})
+  .catch(err => {})
+```
+
+- All methods take a single object parameter (see the
+  [documentation](https://docs.pusher.com/chatkit/reference/javascript) for
+  details on each method's arguments)
+
+- Delegates renamed to `hooks` throughout. e.g.
+
+```javascript
+currentUser.subscribeToRoom({
+  roomId,
+  hooks: {
+    onNewMessage: m => {}
+  }
+})
+```
+
+- Hooks all prefixed with `on`. e.g. `onNewMessage`, `onStartedTyping`
+
+- `cursorSet` hook renamed to `onNewCursor`
+
+- `authContext.queryParams` and `authContext.headers` both moved to the root
+  options object in the token provider. e.g.
+
+```javascript
+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
+
+```javascript
+currentUser.subscribeToRoom(myRoom, hooks) // WRONG
+```
+
+do
+
+```javascript
+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](https://docs.pusher.com/chatkit/reference/javascript#read-cursors)
+  for details.
+
+- Presence data is now accessable on any user object under `user.presence`. e.g.
+
+```javascript
+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
 

package.json

@@ -1,8 +1,8 @@
 {
-  "name": "pusher-chatkit-client",
+  "name": "@pusher/chatkit",
   "description": "Pusher Chatkit client library for browsers and react native",
   "main": "dist/web/chatkit.js",
-  "version": "0.7.0-alpha.7",
+  "version": "0.7.0",
   "author": "Pusher",
   "license": "MIT",
   "homepage": "https://github.com/pusher/chatkit-client-js",