@signalwire/js 3.7.0 → 3.8.0-dev.202202021245.c33a456.0

package/dist/webrtc/src/RTCPeer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RTCPeer.d.ts","sourceRoot":"","sources":["../../../../webrtc/src/RTCPeer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAa,MAAM,kBAAkB,CAAA;AAO1D,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AASjD,MAAM,CAAC,OAAO,OAAO,OAAO,CAAC,UAAU,SAAS,YAAY,CAAC,eAAe;IAmBjE,IAAI,EAAE,cAAc,CAAC,UAAU,CAAC;IAChC,IAAI,EAAE,UAAU;IAnBlB,QAAQ,EAAE,iBAAiB,CAAA;IAElC,OAAO,CAAC,OAAO,CAAmB;IAClC,OAAO,CAAC,WAAW,CAAK;IACxB,OAAO,CAAC,YAAY,CAAQ;IAC5B;;;;OAIG;IACH,OAAO,CAAC,mBAAmB,CAA2B;IACtD,OAAO,CAAC,kBAAkB,CAA0B;IAEpD,OAAO,KAAK,MAAM,GAEjB;gBAGQ,IAAI,EAAE,cAAc,CAAC,UAAU,CAAC,EAChC,IAAI,EAAE,UAAU;IAazB,IAAI,OAAO,YAEV;IAED,IAAI,QAAQ,YAEX;IAED,IAAI,WAAW,YAEd;IAED,IAAI,KAAK,YAER;IAED,IAAI,eAAe,4BAGlB;IAED,IAAI,eAAe,4BAGlB;IAED,IAAI,cAAc,YAEjB;IAED,IAAI,cAAc,YAEjB;IAED,IAAI,gBAAgB,YAEnB;IAED,IAAI,gBAAgB,YAEnB;IAED,IAAI,MAAM,IAAI,gBAAgB,CAW7B;IAED,IAAI,QAAQ,uBAEX;IAED,eAAe,CAAC,IAAI,EAAE,MAAM;IAetB,kBAAkB,CAAC,IAAI,EAAE,MAAM;IAwBrC,WAAW,CAAC,IAAI,EAAE,MAAM;IAcxB,gBAAgB,CAAC,IAAI,EAAE,MAAM;IAa7B,cAAc,CAAC,IAAI,EAAE,MAAM;IAa3B,uBAAuB;IAoBjB,qBAAqB,CACzB,IAAI,EAAE,MAAM,EACZ,WAAW,EAAE,qBAAqB;IAgCpC,OAAO,CAAC,gBAAgB;IAUxB,OAAO,CAAC,kBAAkB;IAUpB,gBAAgB,CAAC,KAAK,UAAQ;IAyD9B,WAAW,CAAC,GAAG,EAAE,MAAM;IAsB7B,OAAO,CAAC,uBAAuB;IAOzB,KAAK;IAoGX,OAAO,CAAC,sBAAsB;YAShB,SAAS;IAsBvB,OAAO,CAAC,MAAM;IAgBd,OAAO,CAAC,oBAAoB;IAiC5B,OAAO,CAAC,qBAAqB;YAoBf,oBAAoB;IAQlC,OAAO,CAAC,gBAAgB;CAsDzB"}
+{"version":3,"file":"RTCPeer.d.ts","sourceRoot":"","sources":["../../../../webrtc/src/RTCPeer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAa,MAAM,kBAAkB,CAAA;AAO1D,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AASjD,MAAM,CAAC,OAAO,OAAO,OAAO,CAAC,UAAU,SAAS,YAAY,CAAC,eAAe;IAmBjE,IAAI,EAAE,cAAc,CAAC,UAAU,CAAC;IAChC,IAAI,EAAE,UAAU;IAnBlB,QAAQ,EAAE,iBAAiB,CAAA;IAElC,OAAO,CAAC,OAAO,CAAmB;IAClC,OAAO,CAAC,WAAW,CAAK;IACxB,OAAO,CAAC,YAAY,CAAQ;IAC5B;;;;OAIG;IACH,OAAO,CAAC,mBAAmB,CAA2B;IACtD,OAAO,CAAC,kBAAkB,CAA0B;IAEpD,OAAO,KAAK,MAAM,GAEjB;gBAGQ,IAAI,EAAE,cAAc,CAAC,UAAU,CAAC,EAChC,IAAI,EAAE,UAAU;IAazB,IAAI,OAAO,YAEV;IAED,IAAI,QAAQ,YAEX;IAED,IAAI,WAAW,YAEd;IAED,IAAI,KAAK,YAER;IAED,IAAI,eAAe,4BAGlB;IAED,IAAI,eAAe,4BAGlB;IAED,IAAI,cAAc,YAEjB;IAED,IAAI,cAAc,YAEjB;IAED,IAAI,gBAAgB,YAEnB;IAED,IAAI,gBAAgB,YAEnB;IAED,IAAI,MAAM,IAAI,gBAAgB,CAW7B;IAED,IAAI,QAAQ,uBAEX;IAED,eAAe,CAAC,IAAI,EAAE,MAAM;IAetB,kBAAkB,CAAC,IAAI,EAAE,MAAM;IAwBrC,WAAW,CAAC,IAAI,EAAE,MAAM;IAcxB,gBAAgB,CAAC,IAAI,EAAE,MAAM;IAa7B,cAAc,CAAC,IAAI,EAAE,MAAM;IAa3B,uBAAuB;IAoBjB,qBAAqB,CACzB,IAAI,EAAE,MAAM,EACZ,WAAW,EAAE,qBAAqB;IAgCpC,OAAO,CAAC,gBAAgB;IAUxB,OAAO,CAAC,kBAAkB;IAUpB,gBAAgB,CAAC,KAAK,UAAQ;IAyD9B,WAAW,CAAC,GAAG,EAAE,MAAM;IAsB7B,OAAO,CAAC,uBAAuB;IAOzB,KAAK;IAoGX,OAAO,CAAC,sBAAsB;YAWhB,SAAS;IAsBvB,OAAO,CAAC,MAAM;IAgBd,OAAO,CAAC,oBAAoB;IAiC5B,OAAO,CAAC,qBAAqB;YAoBf,oBAAoB;IAQlC,OAAO,CAAC,gBAAgB;CAsDzB"}

package/package.json

@@ -3,7 +3,7 @@
   "description": "SignalWire JS SDK",
   "author": "SignalWire Team <open.source@signalwire.com>",
   "license": "MIT",
-  "version": "3.7.0",
+  "version": "3.8.0-dev.202202021245.c33a456.0",
   "main": "dist/index.js",
   "module": "dist/index.esm.js",
   "unpkg": "dist/index.umd.js",
@@ -43,8 +43,8 @@
     "prepublishOnly": "npm run build"
   },
   "dependencies": {
-    "@signalwire/core": "3.4.1",
-    "@signalwire/webrtc": "3.3.0"
+    "@signalwire/core": "3.5.0-dev.202202021245.c33a456.0",
+    "@signalwire/webrtc": "3.3.1-dev.202202021245.c33a456.0"
   },
   "types": "dist/js/src/index.d.ts"
 }

package/src/BaseRoomSession.test.ts

@@ -1,11 +1,11 @@
 import { EventEmitter, actions } from '@signalwire/core'
-import { createBaseRoomSessionObject } from './BaseRoomSession'
+import { BaseRoomSession, createBaseRoomSessionObject } from './BaseRoomSession'
 import type { RoomSession } from './RoomSession'
 import { configureJestStore, configureFullStack } from './testUtils'
 
 describe('Room Object', () => {
   let store: any
-  let room: RoomSession
+  let room: BaseRoomSession<RoomSession>
 
   beforeEach(() => {
     store = configureJestStore()

package/src/BaseRoomSession.ts

@@ -41,6 +41,7 @@ import {
   RoomSessionDeviceConnection,
   RoomSessionDevice,
 } from './RoomSessionDevice'
+import * as workers from './video/workers'
 
 export interface BaseRoomSession<T>
   extends RoomMethods,
@@ -120,6 +121,20 @@ export class RoomSessionConnection
     ])
   }
 
+  /**
+   * This method will be called by `join()` right before the
+   * `connect()` happens and it's a way for us to control
+   * exactly when the workers are attached.
+   * @internal
+   */
+  protected attachPreConnectWorkers() {
+    this.setWorker('memberListUpdated', {
+      worker: workers.memberListUpdatedWorker,
+    })
+
+    this.attachWorkers()
+  }
+
   /** @deprecated Use {@link startScreenShare} instead. */
   async createScreenShareObject(opts: CreateScreenShareObjectOptions = {}) {
     return this.startScreenShare(opts)

package/src/RoomSession.ts

@@ -1,4 +1,8 @@
-import { UserOptions, AssertSameType, getLogger } from '@signalwire/core'
+import {
+  UserOptions,
+  AssertSameType,
+  getLogger,
+} from '@signalwire/core'
 import { createClient } from './createClient'
 import type { MakeRoomOptions } from './Client'
 import { BaseRoomSession } from './BaseRoomSession'
@@ -123,6 +127,9 @@ export const RoomSession = function (roomOptions: RoomSessionOptions) {
   const join = () => {
     return new Promise(async (resolve, reject) => {
       try {
+        // @ts-expect-error
+        room.attachPreConnectWorkers()
+
         await client.connect()
 
         room.once('room.subscribed', () => {
@@ -137,10 +144,15 @@ export const RoomSession = function (roomOptions: RoomSessionOptions) {
     })
   }
 
+  const interceptors = {
+    join,
+  } as const
+
   return new Proxy<Omit<RoomSession, 'new'>>(room, {
-    get(target: RoomSession, prop: any, receiver: any) {
-      if (prop === 'join') {
-        return join
+    get(target: RoomSession, prop: keyof RoomSession, receiver: any) {
+      if (prop in interceptors) {
+        // @ts-expect-error
+        return interceptors[prop]
       }
 
       if (!target.active && UNSAFE_PROP_ACCESS.includes(prop)) {

package/src/chat/Client.test.ts

@@ -69,7 +69,7 @@ describe('ChatClient Object', () => {
               },
             })
           )
-        } else if (parsedData.method === 'chat.presence.set_state') {
+        } else if (parsedData.method === 'chat.member.set_state') {
           socket.send(
             JSON.stringify({
               jsonrpc: '2.0',
@@ -80,7 +80,7 @@ describe('ChatClient Object', () => {
               },
             })
           )
-        } else if (parsedData.method === 'chat.presence.get_state') {
+        } else if (parsedData.method === 'chat.member.get_state') {
           socket.send(
             JSON.stringify({
               jsonrpc: '2.0',
@@ -128,7 +128,7 @@ describe('ChatClient Object', () => {
     await chat.subscribe(['test'])
     await chat.publish({
       channel: 'test',
-      message: 'test',
+      content: 'test',
     })
 
     const connectMsg = JSON.parse(server.messages[0].toString())
@@ -147,7 +147,7 @@ describe('ChatClient Object', () => {
       chat.subscribe(['test']),
       chat.publish({
         channel: 'test',
-        message: 'test',
+        content: 'test',
       }),
     ])
 
@@ -190,7 +190,11 @@ describe('ChatClient Object', () => {
                     channel: 'lobby',
                     message: {
                       id: 'f5511ad5-4dc2-4d28-a449-cc39909093b9',
-                      sender_id: '1507e5f9-075c-463d-94ba-a8f9ec0c7d4e',
+                      member: {
+                        id: '1507e5f9-075c-463d-94ba-a8f9ec0c7d4e',
+                        channel: 'lobby',
+                        state: { active: true },
+                      },
                       content: 'Hello World!',
                       published_at: 1641405257.795,
                     },
@@ -210,7 +214,11 @@ describe('ChatClient Object', () => {
       chat.on('message', (message) => {
         expect(message.channel).toBe('lobby')
         expect(message.id).toBe('f5511ad5-4dc2-4d28-a449-cc39909093b9')
-        expect(message.senderId).toBe('1507e5f9-075c-463d-94ba-a8f9ec0c7d4e')
+        expect(message.member).toStrictEqual({
+          id: '1507e5f9-075c-463d-94ba-a8f9ec0c7d4e',
+          channel: 'lobby',
+          state: { active: true },
+        })
         expect(message.content).toBe('Hello World!')
         expect(message.publishedAt).toStrictEqual(
           new Date(1641405257.795 * 1000)
@@ -256,6 +264,8 @@ describe('ChatClient Object', () => {
             channel: 'lobby',
             member: {
               id: '1507e5f9-075c-463d-94ba-a8f9ec0c7d4e',
+              channel: 'lobby',
+              state: { init: 1 },
             },
           },
           timestamp: 1641468229.28,
@@ -269,6 +279,7 @@ describe('ChatClient Object', () => {
       chat.on('member.joined', (member) => {
         expect(member.channel).toBe('lobby')
         expect(member.id).toBe('1507e5f9-075c-463d-94ba-a8f9ec0c7d4e')
+        expect(member.state).toStrictEqual({ init: 1 })
 
         done()
       })
@@ -288,9 +299,10 @@ describe('ChatClient Object', () => {
             channel: 'lobby',
             member: {
               id: '1507e5f9-075c-463d-94ba-a8f9ec0c7d4e',
-            },
-            state: {
-              typing: true,
+              channel: 'lobby',
+              state: {
+                typing: true,
+              },
             },
           },
           timestamp: 1641468242.538,
@@ -326,6 +338,8 @@ describe('ChatClient Object', () => {
             channel: 'lobby',
             member: {
               id: '1507e5f9-075c-463d-94ba-a8f9ec0c7d4e',
+              channel: 'lobby',
+              state: {},
             },
           },
           timestamp: 1641468229.28,
@@ -339,6 +353,7 @@ describe('ChatClient Object', () => {
       chat.on('member.left', (member) => {
         expect(member.channel).toBe('lobby')
         expect(member.id).toBe('1507e5f9-075c-463d-94ba-a8f9ec0c7d4e')
+        expect(member.state).toStrictEqual({})
 
         done()
       })
@@ -375,7 +390,7 @@ describe('ChatClient Object', () => {
 
       const params = {
         channel: 'test',
-        message: 'test',
+        content: 'test',
       }
 
       await chat.publish(params)
@@ -461,7 +476,7 @@ describe('ChatClient Object', () => {
       // calling unsubscribe()
       await chat.publish({
         channel: 'test',
-        message: 'test',
+        content: 'test',
       })
 
       await expect(() => chat.unsubscribe(['test1_error'])).rejects.toBeTruthy()
@@ -555,14 +570,16 @@ describe('ChatClient Object', () => {
       chat.on('message', () => {})
       await chat.subscribe(['test1'])
 
-      const response = await chat.setState({
+      const response = await chat.setMemberState({
+        memberId: 'memberUuid1',
         channels: 'test1',
         state: { typing: true },
       })
 
       const request = JSON.parse(server.messages[2].toString())
-      expect(request.method).toEqual('chat.presence.set_state')
+      expect(request.method).toEqual('chat.member.set_state')
       expect(request.params).toStrictEqual({
+        member_id: 'memberUuid1',
         channels: [{ name: 'test1' }],
         state: { typing: true },
       })
@@ -580,13 +597,13 @@ describe('ChatClient Object', () => {
       chat.on('message', () => {})
       await chat.subscribe(['test1'])
 
-      const response = await chat.getState({
+      const response = await chat.getMemberState({
         memberId: 'memberId',
         channels: 'test1',
       })
 
       const request = JSON.parse(server.messages[2].toString())
-      expect(request.method).toEqual('chat.presence.get_state')
+      expect(request.method).toEqual('chat.member.get_state')
       expect(request.params).toStrictEqual({
         channels: [{ name: 'test1' }],
         member_id: 'memberId',
@@ -602,5 +619,34 @@ describe('ChatClient Object', () => {
         },
       })
     })
+
+    it('should send the proper RPC without (optional) channels', async () => {
+      const chat = new Client({
+        host,
+        token,
+      })
+      chat.on('message', () => {})
+      await chat.subscribe(['test1'])
+
+      const response = await chat.getMemberState({
+        memberId: 'memberId',
+      })
+
+      const request = JSON.parse(server.messages[2].toString())
+      expect(request.method).toEqual('chat.member.get_state')
+      expect(request.params).toStrictEqual({
+        member_id: 'memberId',
+      })
+
+      expect(response).toStrictEqual({
+        channels: {
+          lobby: {
+            state: {
+              typing: true,
+            },
+          },
+        },
+      })
+    })
   })
 })

package/src/video/workers.ts

@@ -0,0 +1,184 @@
+import {
+  sagaEffects,
+  SagaIterator,
+  SDKWorker,
+  toSyntheticEvent,
+  validateEventsToSubscribe,
+  toInternalEventName,
+  PubSubChannel,
+  InternalVideoMemberEntity,
+} from '@signalwire/core'
+import { RoomSession } from '../RoomSession'
+
+const noop = () => {}
+
+const EXTERNAL_MEMBER_LIST_UPDATED_EVENT = 'video.memberList.updated'
+
+const INTERNAL_MEMBER_LIST_UPDATED_EVENT = toInternalEventName({
+  event: EXTERNAL_MEMBER_LIST_UPDATED_EVENT,
+})
+
+const SYNTHETIC_MEMBER_LIST_UPDATED_EVENT = toSyntheticEvent(
+  INTERNAL_MEMBER_LIST_UPDATED_EVENT
+)
+
+const MEMBER_LIST_EVENTS = [
+  /** Alias to `video.room.subscribed` */
+  'video.room.joined',
+  'video.member.joined',
+  'video.member.left',
+  'video.member.updated',
+]
+
+type MemberList = Map<string, InternalVideoMemberEntity>
+
+const isMemberListEvent = (event: string) => {
+  return MEMBER_LIST_EVENTS.includes(event)
+}
+
+const getMemberListEventsToSubscribe = (subscriptions: string[]) => {
+  return validateEventsToSubscribe(MEMBER_LIST_EVENTS).filter((event) => {
+    return !subscriptions.includes(event as string)
+  })
+}
+
+const shouldHandleMemberList = (subscriptions: string[]) => {
+  return subscriptions.some((event) =>
+    event.includes(INTERNAL_MEMBER_LIST_UPDATED_EVENT)
+  )
+}
+
+const getMembersFromAction = (action: any) => {
+  if (action.type === 'video.room.joined') {
+    return action.payload.room_session.members
+  }
+
+  return [action.payload.member]
+}
+
+const getUpdatedMembers = ({
+  action,
+  memberList,
+}: {
+  action: any
+  memberList: MemberList
+}) => {
+  const actionMembers = getMembersFromAction(action)
+
+  switch (action.type) {
+    case 'video.member.left':
+      actionMembers.forEach((member: InternalVideoMemberEntity) => {
+        memberList.delete(member.id)
+      })
+      break
+    default:
+      actionMembers.forEach((member: InternalVideoMemberEntity) => {
+        memberList.set(member.id, member)
+      })
+  }
+
+  return Array.from(memberList.values())
+}
+
+const initMemberListSubscriptions = (
+  room: RoomSession,
+  subscriptions: string[]
+) => {
+  const events = getMemberListEventsToSubscribe(subscriptions)
+
+  events.forEach((event) => {
+    /**
+     * Params to `subscribe` come from the event handlers
+     * the user has attached so to make sure we subscribe to
+     * all the appropiate events needed for
+     * `memberList.updated` to work, we must subscribe to
+     * the required events. We don't need to act upon the
+     * event (that's why we attach a `noop`), just to
+     * register it (`subscribe` gets its values from
+     * `BaseComponent.getSubscriptions`, which gets
+     * populated by each of the  event handlers the user
+     * attached).
+     */
+    room.once(event as any, noop)
+  })
+
+  /**
+   * This handler will act as a simple bridge between
+   * synthetic events and external events.
+   */
+  const eventBridgeHandler = (payload: any) => {
+    // @ts-expect-error
+    room.emit(EXTERNAL_MEMBER_LIST_UPDATED_EVENT, payload)
+  }
+
+  room.on(SYNTHETIC_MEMBER_LIST_UPDATED_EVENT as any, eventBridgeHandler)
+
+  /**
+   * Any events attached by the saga should be specified
+   * here so it can be cleaned up when needed.
+   */
+  const cleanup = () => {
+    room.off(SYNTHETIC_MEMBER_LIST_UPDATED_EVENT as any, eventBridgeHandler)
+  }
+
+  return {
+    cleanup,
+  }
+}
+
+function* membersListUpdatedWatcher({
+  pubSubChannel,
+}: {
+  pubSubChannel: PubSubChannel
+}): SagaIterator {
+  const memberList: MemberList = new Map()
+
+  function* worker(pubSubAction: any) {
+    const { payload } = pubSubAction
+    const members = getUpdatedMembers({ action: pubSubAction, memberList })
+    const memberListPayload = {
+      room_session_id: payload.room_session_id || payload.room_session.id,
+      members,
+    }
+
+    // TODO: add typings
+    yield sagaEffects.put(pubSubChannel, {
+      type: SYNTHETIC_MEMBER_LIST_UPDATED_EVENT as any,
+      payload: memberListPayload as any,
+    })
+  }
+
+  while (true) {
+    const pubSubAction = yield sagaEffects.take(
+      pubSubChannel,
+      ({ type }: any) => {
+        return isMemberListEvent(type)
+      }
+    )
+
+    yield sagaEffects.fork(worker, pubSubAction)
+  }
+}
+
+export const memberListUpdatedWorker: SDKWorker<RoomSession> =
+  function* membersChangedWorker({
+    channels: { pubSubChannel },
+    instance,
+  }): SagaIterator {
+    // @ts-expect-error
+    const subscriptions = instance.getSubscriptions()
+
+    if (!shouldHandleMemberList(subscriptions)) {
+      return
+    }
+
+    const { cleanup } = initMemberListSubscriptions(instance, subscriptions)
+
+    yield sagaEffects.fork(membersListUpdatedWatcher, {
+      pubSubChannel,
+    })
+
+    instance.once('destroy', () => {
+      cleanup()
+    })
+  }