append 'on' to all hooks

Author: callum-oakley

example/main.js

@@ -26,7 +26,7 @@ chatManager.connect()
       currentUser.subscribeToRoom(
         roomToSubscribeTo.id,
         {
-          newMessage: message => {
+          onNewMessage: message => {
             console.log('new message:', message)
             const messagesList = document.getElementById('messages')
             const messageItem = document.createElement('li')

src/current-user.js

@@ -313,10 +313,10 @@ export class CurrentUser {
         hooks: {
           newCursor: cursor => {
             if (
-              hooks.newReadCursor && cursor.type === 0 &&
+              hooks.onNewReadCursor && cursor.type === 0 &&
               cursor.userId !== this.id
             ) {
-              hooks.newReadCursor(cursor)
+              hooks.onNewReadCursor(cursor)
             }
           }
         },
@@ -452,10 +452,10 @@ export class CurrentUser {
       hooks: {
         newCursor: cursor => {
           if (
-            hooks.newReadCursor && cursor.type === 0 &&
+            hooks.onNewReadCursor && cursor.type === 0 &&
             this.isMemberOf(cursor.roomId)
           ) {
-            hooks.newReadCursor(cursor)
+            hooks.onNewReadCursor(cursor)
           }
         }
       },

src/message-subscription.js

@@ -66,8 +66,8 @@ export class MessageSubscription {
   flushBuffer = () => {
     while (!isEmpty(this.messageBuffer) && head(this.messageBuffer).ready) {
       const message = this.messageBuffer.shift().message
-      if (this.hooks.newMessage) {
-        this.hooks.newMessage(message)
+      if (this.hooks.onNewMessage) {
+        this.hooks.onNewMessage(message)
       }
     }
   }

src/presence-subscription.js

@@ -82,9 +82,9 @@ export class PresenceSubscription {
     map(parsePresence, userStates)
   )
 
-  onCameOnline = user => this.callRelevantHooks('userCameOnline', user)
+  onCameOnline = user => this.callRelevantHooks('onUserCameOnline', user)
 
-  onWentOffline = user => this.callRelevantHooks('userWentOffline', user)
+  onWentOffline = user => this.callRelevantHooks('onUserWentOffline', user)
 
   callRelevantHooks = (hookName, user) => {
     if (this.hooks[hookName]) {

src/typing-indicators.js

@@ -51,20 +51,20 @@ export class TypingIndicators {
   }
 
   onStarted = (room, user, hooks, roomHooks) => {
-    if (hooks.userStartedTyping) {
-      hooks.userStartedTyping(room, user)
+    if (hooks.onUserStartedTyping) {
+      hooks.onUserStartedTyping(room, user)
     }
-    if (roomHooks[room.id] && roomHooks[room.id].userStartedTyping) {
-      roomHooks[room.id].userStartedTyping(user)
+    if (roomHooks[room.id] && roomHooks[room.id].onUserStartedTyping) {
+      roomHooks[room.id].onUserStartedTyping(user)
     }
   }
 
   onStopped = (room, user, hooks, roomHooks) => {
-    if (hooks.userStoppedTyping) {
-      hooks.userStoppedTyping(room, user)
+    if (hooks.onUserStoppedTyping) {
+      hooks.onUserStoppedTyping(room, user)
     }
-    if (roomHooks[room.id] && roomHooks[room.id].userStoppedTyping) {
-      roomHooks[room.id].userStoppedTyping(user)
+    if (roomHooks[room.id] && roomHooks[room.id].onUserStoppedTyping) {
+      roomHooks[room.id].onUserStoppedTyping(user)
     }
   }
 }

src/user-subscription.js

@@ -69,32 +69,32 @@ export class UserSubscription {
   onAddedToRoom = ({ room: roomData }) => {
     const basicRoom = parseBasicRoom(roomData)
     this.roomStore.set(basicRoom.id, basicRoom).then(room => {
-      if (this.hooks.addedToRoom) {
-        this.hooks.addedToRoom(room)
+      if (this.hooks.onAddedToRoom) {
+        this.hooks.onAddedToRoom(room)
       }
     })
   }
 
   onRemovedFromRoom = ({ room_id: roomId }) => {
     this.roomStore.pop(roomId).then(room => {
       // room will be undefined if we left with leaveRoom
-      if (room && this.hooks.removedFromRoom) {
-        this.hooks.removedFromRoom(room)
+      if (room && this.hooks.onRemovedFromRoom) {
+        this.hooks.onRemovedFromRoom(room)
       }
     })
   }
 
   onUserJoined = ({ room_id: roomId, user_id: userId }) => {
     this.roomStore.addUserToRoom(roomId, userId).then(room => {
       this.userStore.get(userId).then(user => {
-        if (this.hooks.userJoinedRoom) {
-          this.hooks.userJoinedRoom(room, user)
+        if (this.hooks.onUserJoinedRoom) {
+          this.hooks.onUserJoinedRoom(room, user)
         }
         if (
           this.roomSubscriptions[roomId] &&
-          this.roomSubscriptions[roomId].hooks.userJoined
+          this.roomSubscriptions[roomId].hooks.onUserJoined
         ) {
-          this.roomSubscriptions[roomId].hooks.userJoined(user)
+          this.roomSubscriptions[roomId].hooks.onUserJoined(user)
         }
       })
     })
@@ -103,14 +103,14 @@ export class UserSubscription {
   onUserLeft = ({ room_id: roomId, user_id: userId }) => {
     this.roomStore.removeUserFromRoom(roomId, userId).then(room => {
       this.userStore.get(userId).then(user => {
-        if (this.hooks.userLeftRoom) {
-          this.hooks.userLeftRoom(room, user)
+        if (this.hooks.onUserLeftRoom) {
+          this.hooks.onUserLeftRoom(room, user)
         }
         if (
           this.roomSubscriptions[roomId] &&
-          this.roomSubscriptions[roomId].hooks.userLeft
+          this.roomSubscriptions[roomId].hooks.onUserLeft
         ) {
-          this.roomSubscriptions[roomId].hooks.userLeft(user)
+          this.roomSubscriptions[roomId].hooks.onUserLeft(user)
         }
       })
     })
@@ -119,16 +119,16 @@ export class UserSubscription {
   onRoomUpdated = ({ room: roomData }) => {
     const updates = parseBasicRoom(roomData)
     this.roomStore.update(updates.id, updates).then(room => {
-      if (this.hooks.roomUpdated) {
-        this.hooks.roomUpdated(room)
+      if (this.hooks.onRoomUpdated) {
+        this.hooks.onRoomUpdated(room)
       }
     })
   }
 
   onRoomDeleted = ({ room_id: roomId }) => {
     this.roomStore.pop(roomId).then(room => {
-      if (room && this.hooks.roomDeleted) {
-        this.hooks.roomDeleted(room)
+      if (room && this.hooks.onRoomDeleted) {
+        this.hooks.onRoomDeleted(room)
       }
     })
   }

tests/main.js

@@ -255,7 +255,7 @@ test('own read cursor undefined if not set', t => {
 
 test('new read cursor hook [Alice sets her read cursor in her room]', t => {
   Promise.all([fetchUser(t, 'alice'), fetchUser(t, 'alice', {
-    newReadCursor: cursor => {
+    onNewReadCursor: cursor => {
       t.equal(cursor.position, 42)
       t.equal(cursor.user.name, 'Alice')
       t.equal(cursor.room.name, `Alice's room`)
@@ -285,7 +285,7 @@ test('get own read cursor', t => {
 test(`added to room hook [creates Bob & Bob's room]`, t => {
   let alice
   fetchUser(t, 'alice', {
-    addedToRoom: room => {
+    onAddedToRoom: room => {
       t.equal(room.name, `Bob's room`)
       t.true(
         any(r => r.id === room.id, alice.rooms),
@@ -314,7 +314,7 @@ test(`added to room hook [creates Bob & Bob's room]`, t => {
 // (since then he will already be online)
 test('user came online hook (user sub)', t => {
   fetchUser(t, 'alice', {
-    userCameOnline: user => {
+    onUserCameOnline: user => {
       t.equal(user.id, 'bob')
       t.equal(user.presence.state, 'online')
       t.end()
@@ -327,7 +327,7 @@ test('user came online hook (user sub)', t => {
 
 test('user went offline hook (user sub)', t => {
   fetchUser(t, 'alice', {
-    userWentOffline: user => {
+    onUserWentOffline: user => {
       t.equal(user.id, 'bob')
       t.equal(user.presence.state, 'offline')
       t.end()
@@ -342,12 +342,12 @@ test('typing indicators (user sub)', t => {
   let started
   Promise.all([
     fetchUser(t, 'alice', {
-      userStartedTyping: (room, user) => {
+      onUserStartedTyping: (room, user) => {
         started = Date.now()
         t.equal(room.id, bobsRoom.id)
         t.equal(user.id, 'bob')
       },
-      userStoppedTyping: (room, user) => {
+      onUserStoppedTyping: (room, user) => {
         t.equal(room.id, bobsRoom.id)
         t.equal(user.id, 'bob')
         t.true(Date.now() - started > 1000, 'fired more than 1s after start')
@@ -366,7 +366,7 @@ test('typing indicators (user sub)', t => {
 
 test('user left room hook (user sub) [removes Bob from his own room]', t => {
   fetchUser(t, 'alice', {
-    userLeftRoom: (room, user) => {
+    onUserLeftRoom: (room, user) => {
       t.equal(room.id, bobsRoom.id)
       t.equal(user.id, 'bob')
       t.end()
@@ -384,7 +384,7 @@ test('user left room hook (user sub) [removes Bob from his own room]', t => {
 
 test('user joined room hook (user sub) [Bob rejoins his own room]', t => {
   fetchUser(t, 'alice', {
-    userJoinedRoom: (room, user) => {
+    onUserJoinedRoom: (room, user) => {
       t.equal(room.id, bobsRoom.id)
       t.equal(user.id, 'bob')
       t.end()
@@ -402,7 +402,7 @@ test('user joined room hook (user sub) [Bob rejoins his own room]', t => {
 
 test('room updated hook', t => {
   fetchUser(t, 'alice', {
-    roomUpdated: room => {
+    onRoomUpdated: room => {
       t.equal(room.id, bobsRoom.id)
       t.equal(room.name, `Bob's renamed room`)
       t.end()
@@ -420,7 +420,7 @@ test('room updated hook', t => {
 
 test(`removed from room hook [removes Alice from Bob's room]`, t => {
   fetchUser(t, 'alice', {
-    removedFromRoom: room => {
+    onRemovedFromRoom: room => {
       t.equal(room.id, bobsRoom.id)
       t.end()
     }
@@ -437,7 +437,7 @@ test(`removed from room hook [removes Alice from Bob's room]`, t => {
 
 test(`room deleted hook [destroys Alice's room]`, t => {
   fetchUser(t, 'alice', {
-    roomDeleted: room => {
+    onRoomDeleted: room => {
       t.equal(room.id, alicesRoom.id)
       t.end()
     }
@@ -668,7 +668,7 @@ test('subscribe to room and fetch initial messages', t => {
     .then(alice => alice.subscribeToRoom({
       roomId: bobsRoom.id,
       hooks: {
-        newMessage: concatBatch(4, messages => {
+        onNewMessage: concatBatch(4, messages => {
           t.deepEqual(map(m => m.text, messages), ['hello', 'hey', 'hi', 'ho'])
           t.equal(messages[0].sender.name, 'Alice')
           t.equal(messages[0].room.name, `Bob's new room`)
@@ -685,7 +685,7 @@ test('subscribe to room and fetch last two message only', t => {
     .then(alice => alice.subscribeToRoom({
       roomId: bobsRoom.id,
       hooks: {
-        newMessage: concatBatch(2, messages => {
+        onNewMessage: concatBatch(2, messages => {
           t.deepEqual(map(m => m.text, messages), ['hi', 'ho'])
           t.end()
         })
@@ -701,7 +701,7 @@ test('subscribe to room and receive sent messages', t => {
     .then(alice => alice.subscribeToRoom({
       roomId: bobsRoom.id,
       hooks: {
-        newMessage: concatBatch(3, messages => {
+        onNewMessage: concatBatch(3, messages => {
           t.deepEqual(map(m => m.text, messages), ['yo', 'yoo', 'yooo'])
           t.equal(messages[0].sender.name, 'Alice')
           t.equal(messages[0].room.name, `Bob's new room`)
@@ -720,7 +720,7 @@ test('unsubscribe from room', t => {
     .then(alice => alice.subscribeToRoom({
       roomId: bobsRoom.id,
       hooks: {
-        newMessage: once(m => {
+        onNewMessage: once(m => {
           endWithErr(t, 'should not be called after unsubscribe')
         })
       },
@@ -859,7 +859,7 @@ test(`user joined hook [Carol joins Bob's room]`, t => {
     .then(alice => alice.subscribeToRoom({
       roomId: bobsRoom.id,
       hooks: {
-        userJoined: once(user => {
+        onUserJoined: once(user => {
           t.equal(user.id, 'carol')
           t.equal(user.name, 'Carol')
           t.end()
@@ -883,7 +883,7 @@ test('user came online hook', t => {
     .then(alice => alice.subscribeToRoom({
       roomId: bobsRoom.id,
       hooks: {
-        userCameOnline: once(user => {
+        onUserCameOnline: once(user => {
           t.equal(user.id, 'carol')
           t.equal(user.name, 'Carol')
           t.equal(user.presence.state, 'online')
@@ -901,7 +901,7 @@ test('user went offline hook', t => {
     .then(alice => alice.subscribeToRoom({
       roomId: bobsRoom.id,
       hooks: {
-        userWentOffline: once(user => {
+        onUserWentOffline: once(user => {
           t.equal(user.id, 'carol')
           t.equal(user.name, 'Carol')
           t.equal(user.presence.state, 'offline')
@@ -921,12 +921,12 @@ test('typing indicators', t => {
     .then(alice => alice.subscribeToRoom({
       roomId: bobsRoom.id,
       hooks: {
-        userStartedTyping: once(user => {
+        onUserStartedTyping: once(user => {
           started = Date.now()
           t.equal(user.id, 'carol')
           t.equal(user.name, 'Carol')
         }),
-        userStoppedTyping: once(user => {
+        onUserStoppedTyping: once(user => {
           t.equal(user.id, 'carol')
           t.equal(user.name, 'Carol')
           t.true(Date.now() - started > 1000, 'fired more than 1s after start')
@@ -949,7 +949,7 @@ test(`user left hook [removes Carol from Bob's room]`, t => {
     .then(alice => alice.subscribeToRoom({
       roomId: bobsRoom.id,
       hooks: {
-        userLeft: once(user => {
+        onUserLeft: once(user => {
           t.equal(user.id, 'carol')
           t.equal(user.name, 'Carol')
           t.end()
@@ -976,7 +976,7 @@ test(`new read cursor hook [Bob sets his read cursor in Alice's room]`, t => {
     .then(alice => alice.subscribeToRoom({
       roomId: alicesRoom.id,
       hooks: {
-        newReadCursor: cursor => {
+        onNewReadCursor: cursor => {
           t.equal(cursor.position, 128)
           t.equal(cursor.user.name, 'Bob')
           t.equal(cursor.room.name, `Alice's new room`)
@@ -1070,7 +1070,7 @@ test('[setup] promote Alice to admin', t => {
 
 test(`update room [renames Bob's room]`, t => {
   fetchUser(t, 'alice', {
-    roomUpdated: room => {
+    onRoomUpdated: room => {
       t.equal(room.id, bobsRoom.id)
       t.equal(room.name, `Bob's updated room`)
       t.end()
@@ -1088,7 +1088,7 @@ test(`update room [renames Bob's room]`, t => {
 test(`delete room [deletes Bob's room]`, t => {
   let alice
   fetchUser(t, 'alice', {
-    roomDeleted: room => {
+    onRoomDeleted: room => {
       t.equal(room.id, bobsRoom.id)
       t.false(
         any(r => r.id === bobsRoom.id, alice.rooms),