@100mslive/hms-video-store 0.2.75-1 → 0.2.78

package/dist/test/fakeStore.d.ts

@@ -1,7 +1,8 @@
 import { HMSPeer, HMSSpeaker, HMSStore, HMSTrack } from '../core';
 import { HMSPlaylist, HMSRole } from '../core/schema';
 export declare let localPeer: HMSPeer;
-export declare let remotePeer: HMSPeer;
+export declare let remotePeerOne: HMSPeer;
+export declare let remotePeerTwo: HMSPeer;
 export declare let peerScreenSharing: HMSPeer;
 export declare let localVideo: HMSTrack;
 export declare let localAudio: HMSTrack;

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.2.75-1",
+  "version": "0.2.78",
   "license": "MIT",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -57,10 +57,10 @@
     "zustand": "3.5.7"
   },
   "peerDependencies": {
-    "@100mslive/hms-video": "^0.1.26"
+    "@100mslive/hms-video": "^0.1.32"
   },
   "devDependencies": {
-    "@100mslive/hms-video": "^0.1.26",
+    "@100mslive/hms-video": "^0.1.32",
     "@cypress/code-coverage": "^3.9.11",
     "@istanbuljs/nyc-config-typescript": "^1.0.1",
     "@size-limit/file": "^5.0.3",

package/src/core/IHMSActions.ts

@@ -17,7 +17,7 @@ import {
   HMSChangeMultiTrackStateParams,
 } from './schema';
 import { HMSRoleChangeRequest } from './selectors';
-import { RTMPRecordingConfig } from './hmsSDKStore/sdkTypes';
+import { RTMPRecordingConfig, HMSPeerUpdateConfig } from './hmsSDKStore/sdkTypes';
 
 /**
  * The below interface defines our SDK API Surface for taking room related actions.
@@ -280,6 +280,15 @@ export interface IHMSActions {
    */
   stopRTMPAndRecording(): Promise<void>;
 
+  /**
+   * If both name and data is undefined: Message is ignored.
+   * If data is undefined: Name of the peer is changed.
+   * If name is undefined: Metadata of the peer is updated.
+   * If both name and data is defined: Both name and metadata is updated.
+   * @alpha
+   */
+  updatePeer(params: HMSPeerUpdateConfig): Promise<void>;
+
   /**
    * Set the type of logs from the SDK you want to be logged in the browser console.
    *

package/src/core/hmsSDKStore/HMSNotifications.ts

@@ -58,11 +58,16 @@ export class HMSNotifications implements IHMSNotifications {
   }
 
   sendLeaveRoom(request: HMSLeaveRoomRequest) {
+    const peerName = request.requestedBy?.name;
     const notification = this.createNotification(
-      request.roomEnded ? HMSNotificationTypes.ROOM_ENDED : HMSNotificationTypes.REMOVED_FROM_ROOM,
+      request.roomEnded || !peerName
+        ? HMSNotificationTypes.ROOM_ENDED
+        : HMSNotificationTypes.REMOVED_FROM_ROOM,
       request,
       HMSNotificationSeverity.INFO,
-      `${request.roomEnded ? `Room ended` : 'Removed from room'} by ${request.requestedBy.name}`,
+      `${request.roomEnded ? `Room ended` : 'Removed from room'} ${
+        peerName ? `by ${peerName}` : ''
+      }`,
     );
     this.emitEvent(notification);
   }

package/src/core/hmsSDKStore/HMSSDKActions.ts

@@ -69,6 +69,8 @@ import { HMSNotifications } from './HMSNotifications';
 import { NamedSetState } from './internalTypes';
 import { isRemoteTrack } from './sdkUtils/sdkUtils';
 import { HMSPlaylist } from './HMSPlaylist';
+import { ACTION_TYPES } from './common/mapping';
+
 // import { ActionBatcher } from './sdkUtils/ActionBatcher';
 
 /**
@@ -448,6 +450,16 @@ export class HMSSDKActions implements IHMSActions {
     await this.sdk.stopRTMPAndRecording();
   }
 
+  async updatePeer(params: sdkTypes.HMSPeerUpdateConfig) {
+    await this.sdk.updatePeer(params);
+    if (params.name) {
+      this.syncRoomState('nameUpdated');
+    }
+    if (params.metadata) {
+      this.syncRoomState('metadataUpdated');
+    }
+  }
+
   async setRemoteTrackEnabled(trackID: HMSTrackID | HMSTrackID[], enabled: boolean) {
     if (typeof trackID === 'string') {
       const track = this.hmsSDKTracks[trackID];
@@ -513,19 +525,13 @@ export class HMSSDKActions implements IHMSActions {
   }
 
   private onRemovedFromRoom(request: SDKHMSLeaveRoomRequest) {
-    const requestedBy = this.store.getState(selectPeerByID(request.requestedBy.peerId));
-    if (!requestedBy) {
-      this.logPossibleInconsistency(
-        `Not found peer who requested leave room, ${request.requestedBy}`,
-      );
-      return;
-    }
+    const requestedBy = this.store.getState(selectPeerByID(request.requestedBy?.peerId));
     this.hmsNotifications.sendLeaveRoom({
       ...request,
-      requestedBy,
+      requestedBy: requestedBy || undefined,
     });
     HMSLogger.i('resetting state after peer removed', request);
-    this.resetState(request.roomEnded ? 'roomEnded' : 'removedFromRoom');
+    this.resetState(request.roomEnded || !requestedBy ? 'roomEnded' : 'removedFromRoom');
   }
 
   private onDeviceChange(event: sdkTypes.HMSDeviceChangeEvent) {
@@ -1129,11 +1135,7 @@ export class HMSSDKActions implements IHMSActions {
   ) => {
     let peer = this.store.getState(selectPeerByID(sdkPeer.peerId));
     let actionName = 'peerUpdate';
-    if (type === sdkTypes.HMSPeerUpdate.PEER_JOINED) {
-      actionName = 'peerJoined';
-    } else if (type === sdkTypes.HMSPeerUpdate.PEER_LEFT) {
-      actionName = 'peerLeft';
-    }
+    actionName = ACTION_TYPES[type];
     this.syncRoomState(actionName);
     // if peer wasn't available before sync(will happen if event is peer join)
     if (!peer) {

package/src/core/hmsSDKStore/common/mapping.ts

@@ -11,6 +11,8 @@ export const PEER_NOTIFICATION_TYPES: notifcationMap = {
   [sdkTypes.HMSPeerUpdate.ROLE_UPDATED]: HMSNotificationTypes.ROLE_UPDATED,
   [sdkTypes.HMSPeerUpdate.AUDIO_TOGGLED]: 'PEER_AUDIO_UPDATED',
   [sdkTypes.HMSPeerUpdate.VIDEO_TOGGLED]: 'PEER_VIDEO_UPDATED',
+  [sdkTypes.HMSPeerUpdate.NAME_UPDATED]: HMSNotificationTypes.NAME_UPDATED,
+  [sdkTypes.HMSPeerUpdate.METADATA_UPDATED]: HMSNotificationTypes.METADATA_UPDATED,
 };
 
 export const TRACK_NOTIFICATION_TYPES: notifcationMap = {
@@ -19,3 +21,10 @@ export const TRACK_NOTIFICATION_TYPES: notifcationMap = {
   [sdkTypes.HMSTrackUpdate.TRACK_MUTED]: HMSNotificationTypes.TRACK_MUTED,
   [sdkTypes.HMSTrackUpdate.TRACK_UNMUTED]: HMSNotificationTypes.TRACK_UNMUTED,
 };
+
+export const ACTION_TYPES: notifcationMap = {
+  [sdkTypes.HMSPeerUpdate.PEER_JOINED]: 'peerJoined',
+  [sdkTypes.HMSPeerUpdate.PEER_LEFT]: 'peerLeft',
+  [sdkTypes.HMSPeerUpdate.NAME_UPDATED]: 'nameUpdated',
+  [sdkTypes.HMSPeerUpdate.METADATA_UPDATED]: 'metadataUpdated',
+};

package/src/core/hmsSDKStore/sdkTypes.ts

@@ -24,6 +24,7 @@ import {
   RTMPRecordingConfig,
   HMSRecording,
   HMSRTMP,
+  HMSPeerUpdateConfig,
 } from '@100mslive/hms-video';
 
 export {
@@ -52,4 +53,5 @@ export {
   RTMPRecordingConfig,
   HMSRecording,
   HMSRTMP,
+  HMSPeerUpdateConfig,
 };

package/src/core/schema/notification.ts

@@ -34,4 +34,6 @@ export enum HMSNotificationTypes {
   REMOVED_FROM_ROOM = 'REMOVED_FROM_ROOM',
   DEVICE_CHANGE_UPDATE = 'DEVICE_CHANGE_UPDATE',
   PLAYLIST_TRACK_ENDED = 'PLAYLIST_TRACK_ENDED',
+  NAME_UPDATED = 'NAME_UPDATED',
+  METADATA_UPDATED = 'METADATA_UPDATED',
 }

package/src/core/schema/requests.ts

@@ -30,7 +30,7 @@ export interface HMSChangeMultiTrackStateParams {
 }
 
 export interface HMSLeaveRoomRequest {
-  requestedBy: HMSPeer;
+  requestedBy?: HMSPeer;
   reason: string;
   roomEnded: boolean;
 }

package/src/core/selectors/selectorsByID.ts

@@ -1,5 +1,11 @@
 import { createSelector } from 'reselect';
-import { selectHMSMessages, selectLocalPeerID, selectPeersMap, selectTracksMap } from './selectors';
+import {
+  selectHMSMessages,
+  selectLocalPeerID,
+  selectPeers,
+  selectPeersMap,
+  selectTracksMap,
+} from './selectors';
 import { HMSPeerID, HMSRoleName, HMSStore, HMSTrack, HMSTrackID } from '../schema';
 import {
   getPeerTracksByCondition,
@@ -368,3 +374,13 @@ export const selectMessagesByRole = byIDCurry(selectMessagesByRoleInternal);
 
 export const selectMessagesUnreadCountByRole = byIDCurry(selectUnreadMessageCountByRole);
 export const selectMessagesUnreadCountByPeerID = byIDCurry(selectUnreadMessageCountByPeerID);
+
+/**
+ * Select an array of peers of a particular role
+ * @param role HMSRoleName
+ * @returns HMSPeer[]
+ */
+export const selectPeersByRole = (role: HMSRoleName) =>
+  createSelector([selectPeers], peers => {
+    return peers.filter(p => p.roleName === role);
+  });

package/src/test/fakeStore.ts

@@ -32,7 +32,8 @@ function makeTrack(
 }
 
 export let localPeer: HMSPeer;
-export let remotePeer: HMSPeer;
+export let remotePeerOne: HMSPeer;
+export let remotePeerTwo: HMSPeer;
 export let peerScreenSharing: HMSPeer;
 export let localVideo: HMSTrack;
 export let localAudio: HMSTrack;
@@ -58,7 +59,7 @@ export const makeFakeStore = (): HMSStore => {
       id: '123',
       isConnected: true,
       name: 'test room',
-      peers: ['1', '2'],
+      peers: ['1', '2', '3'],
       localPeer: '1',
       shareableLink: '',
       hasWaitingRoom: false,
@@ -94,6 +95,15 @@ export const makeFakeStore = (): HMSStore => {
         audioTrack: '104',
         auxiliaryTracks: ['105', '106', '107'],
       },
+      '3': {
+        id: '3',
+        name: 'test3',
+        roleName: ROLES.SPEAKER,
+        isLocal: false,
+        videoTrack: '105',
+        audioTrack: '106',
+        auxiliaryTracks: [],
+      },
     },
     tracks: {
       '101': makeTrack('101', 'video', 'regular', '1'),
@@ -243,7 +253,8 @@ export const makeFakeStore = (): HMSStore => {
   };
 
   localPeer = fakeStore.peers['1'];
-  remotePeer = fakeStore.peers['2'];
+  remotePeerOne = fakeStore.peers['2'];
+  remotePeerTwo = fakeStore.peers['3'];
   peerScreenSharing = fakeStore.peers['2'];
   localVideo = fakeStore.tracks['101'];
   localAudio = fakeStore.tracks['102'];

package/src/test/unit/roleSelectors.test.ts

@@ -8,7 +8,14 @@ import {
   selectIsAllowedToPublish,
   selectIsAllowedToSubscribe,
 } from '../../core';
-import { hostRole, localPeer, makeFakeStore, remotePeer, ROLES, speakerRole } from '../fakeStore';
+import {
+  hostRole,
+  localPeer,
+  makeFakeStore,
+  remotePeerOne,
+  ROLES,
+  speakerRole,
+} from '../fakeStore';
 
 let fakeStore: HMSStore;
 
@@ -38,7 +45,7 @@ describe('test role related selectors', () => {
 
   test('selectRole change request', () => {
     const req = selectRoleChangeRequest(fakeStore);
-    expect(req?.requestedBy).toBe(remotePeer);
+    expect(req?.requestedBy).toBe(remotePeerOne);
     expect(req?.role.name).toBe(ROLES.SPEAKER);
     expect(req?.role).toBe(speakerRole);
     expect(req?.token).toBe('123');

package/src/test/unit/selectors.test.ts

@@ -11,6 +11,8 @@ import {
   screenShare,
   screenshareAudio,
   playlist,
+  remotePeerTwo,
+  remotePeerOne,
 } from '../fakeStore';
 import {
   HMSStore,
@@ -65,6 +67,7 @@ import {
   selectMessagesUnreadCountByPeerID,
   selectAudioPlaylist,
   selectVideoPlaylist,
+  selectPeersByRole,
 } from '../../core';
 
 let fakeStore: HMSStore;
@@ -150,7 +153,7 @@ describe('secondary selectors', () => {
   });
 
   test('remote peers', () => {
-    expect(selectRemotePeers(fakeStore)).toEqual([peerScreenSharing]);
+    expect(selectRemotePeers(fakeStore)).toEqual([remotePeerOne, remotePeerTwo]);
   });
 
   test('some track degraded', () => {
@@ -283,6 +286,12 @@ describe('by ID selectors', () => {
     const messages = selectBroadcastMessagesUnreadCount(fakeStore);
     expect(messages).toBe(0);
   });
+
+  test('selectPeersByRole', () => {
+    expect(selectPeersByRole('speaker')(fakeStore)).toEqual([remotePeerTwo]);
+    // If role is not present
+    expect(selectPeersByRole('incognito')(fakeStore)).toEqual([]);
+  });
 });
 
 describe('derived selectors', () => {
@@ -291,6 +300,7 @@ describe('derived selectors', () => {
     expect(selectPeersWithAudioStatus(fakeStore)).toEqual([
       { peer: localPeer, isAudioEnabled: true },
       { peer: peerScreenSharing, isAudioEnabled: false },
+      { peer: remotePeerTwo, isAudioEnabled: false },
     ]);
   });
 });