Return RoomSessionMember object instead of plain Member object in realtime-api

.changeset/tidy-files-reflect.md

@@ -0,0 +1,5 @@
+---
+'@signalwire/realtime-api': patch
+---
+
+Return RoomSessionMember object instead of plain Member object

packages/realtime-api/src/video/RoomSession.ts

@@ -22,7 +22,11 @@ import {
   Optional,
 } from '@signalwire/core'
 import { RealTimeRoomApiEvents } from '../types'
-import { RoomSessionMember } from './RoomSessionMember'
+import {
+  RoomSessionMember,
+  RoomSessionMemberEventParams,
+  createRoomSessionMemberObject,
+} from './RoomSessionMember'
 
 type EmitterTransformsEvents =
   | InternalVideoRoomSessionEventNames
@@ -41,6 +45,15 @@ export interface RoomSession
     ConsumerContract<RealTimeRoomApiEvents, RoomSessionFullState> {
   baseEmitter: EventEmitter
   setPayload(payload: Optional<VideoRoomEventParams, 'room'>): void
+  /**
+   * Returns a list of members currently in the room.
+   *
+   * @example
+   * ```typescript
+   * await room.getMembers()
+   * ```
+   */
+  getMembers(): Promise<{ members: RoomSessionMember[] }>
 }
 
 export type RoomSessionUpdated = EntityUpdated<RoomSession>
@@ -199,15 +212,58 @@ export class RoomSessionConsumer extends BaseConsumer<RealTimeRoomApiEvents> {
   protected setPayload(payload: Optional<VideoRoomEventParams, 'room'>) {
     this._payload = payload
   }
+
+  getMembers() {
+    return new Promise(async (resolve, reject) => {
+      try {
+        const { members } = await this.execute<
+          void,
+          { members: RoomSessionMemberEventParams['member'][] }
+        >({
+          method: 'video.members.get',
+          params: {
+            room_session_id: this.roomSessionId,
+          },
+        })
+
+        const memberInstances: RoomSessionMember[] = []
+        members.forEach((member) => {
+          let memberInstance = this.instanceMap.get<RoomSessionMember>(
+            member.id
+          )
+          if (!memberInstance) {
+            memberInstance = createRoomSessionMemberObject({
+              store: this.store,
+              // @ts-expect-error
+              emitter: this.emitter,
+              payload: { member },
+            })
+          } else {
+            memberInstance.setPayload({
+              member,
+            } as RoomSessionMemberEventParams)
+          }
+          memberInstances.push(memberInstance)
+          this.instanceMap.set<RoomSessionMember>(
+            memberInstance.id,
+            memberInstance
+          )
+        })
+
+        resolve({ members: memberInstances })
+      } catch (error) {
+        reject(error)
+      }
+    })
+  }
 }
 
 export const RoomSessionAPI = extendComponent<
   RoomSessionConsumer,
-  VideoRoomSessionMethods
+  Omit<VideoRoomSessionMethods, 'getMembers'>
 >(RoomSessionConsumer, {
   videoMute: Rooms.videoMuteMember,
   videoUnmute: Rooms.videoUnmuteMember,
-  getMembers: Rooms.getMembers,
   audioMute: Rooms.audioMuteMember,
   audioUnmute: Rooms.audioUnmuteMember,
   deaf: Rooms.deafMember,