@100mslive/hms-video-store 0.2.78 → 0.2.81

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.2.78",
+  "version": "0.2.81",
   "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.32"
+    "@100mslive/hms-video": "^0.1.34"
   },
   "devDependencies": {
-    "@100mslive/hms-video": "^0.1.32",
+    "@100mslive/hms-video": "^0.1.34",
     "@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, HMSPeerUpdateConfig } from './hmsSDKStore/sdkTypes';
+import { RTMPRecordingConfig } from './hmsSDKStore/sdkTypes';
 
 /**
  * The below interface defines our SDK API Surface for taking room related actions.
@@ -281,13 +281,16 @@ 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
+   * If you want to update the name of peer.
+   * @beta
    */
-  updatePeer(params: HMSPeerUpdateConfig): Promise<void>;
+  changeName(name: string): Promise<void>;
+
+  /**
+   * If you want to update the metadata of peer.
+   * @beta
+   */
+  changeMetadata(metadata: string): Promise<void>;
 
   /**
    * Set the type of logs from the SDK you want to be logged in the browser console.

package/src/core/hmsSDKStore/HMSSDKActions.ts

@@ -450,14 +450,20 @@ 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 changeName(name: string) {
+    await this.sdk.changeName(name);
+    this.setState(store => {
+      const localPeer = selectLocalPeer(store);
+      localPeer.name = name;
+    }, 'peerNameUpdated');
+  }
+
+  async changeMetadata(metadata: string) {
+    await this.sdk.changeMetadata(metadata);
+    this.setState(store => {
+      const localPeer = selectLocalPeer(store);
+      localPeer.metadata = metadata;
+    }, 'peerMetadataUpdated');
   }
 
   async setRemoteTrackEnabled(trackID: HMSTrackID | HMSTrackID[], enabled: boolean) {

package/src/core/hmsSDKStore/adapter.ts

@@ -35,7 +35,8 @@ export class SDKToHMS {
       audioTrack: sdkPeer.audioTrack?.trackId,
       auxiliaryTracks: sdkPeer.auxiliaryTracks.map(track => track.trackId),
       customerUserId: sdkPeer.customerUserId,
-      customerDescription: sdkPeer.customerDescription,
+      customerDescription: sdkPeer.metadata,
+      metadata: sdkPeer.metadata,
     };
   }
 

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

@@ -20,11 +20,13 @@ export const TRACK_NOTIFICATION_TYPES: notifcationMap = {
   [sdkTypes.HMSTrackUpdate.TRACK_REMOVED]: HMSNotificationTypes.TRACK_REMOVED,
   [sdkTypes.HMSTrackUpdate.TRACK_MUTED]: HMSNotificationTypes.TRACK_MUTED,
   [sdkTypes.HMSTrackUpdate.TRACK_UNMUTED]: HMSNotificationTypes.TRACK_UNMUTED,
+  [sdkTypes.HMSTrackUpdate.TRACK_DEGRADED]: HMSNotificationTypes.TRACK_DEGRADED,
+  [sdkTypes.HMSTrackUpdate.TRACK_RESTORED]: HMSNotificationTypes.TRACK_RESTORED,
 };
 
 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',
+  [sdkTypes.HMSPeerUpdate.NAME_UPDATED]: 'peerNameUpdated',
+  [sdkTypes.HMSPeerUpdate.METADATA_UPDATED]: 'peerMetadataUpdated',
 };

package/src/core/hmsSDKStore/sdkTypes.ts

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

package/src/core/schema/notification.ts

@@ -26,6 +26,8 @@ export enum HMSNotificationTypes {
   TRACK_REMOVED = 'TRACK_REMOVED',
   TRACK_MUTED = 'TRACK_MUTED',
   TRACK_UNMUTED = 'TRACK_UNMUTED',
+  TRACK_DEGRADED = 'TRACK_DEGRADED',
+  TRACK_RESTORED = 'TRACK_RESTORED',
   ROLE_CHANGE_REQUEST = 'ROLE_CHANGE_REQUEST',
   ROLE_UPDATED = 'ROLE_UPDATED',
   CHANGE_TRACK_STATE_REQUEST = 'CHANGE_TRACK_STATE_REQUEST',

package/src/core/schema/peer.ts

@@ -28,6 +28,11 @@ export interface HMSPeer {
   audioTrack?: HMSTrackID;
   auxiliaryTracks: HMSTrackID[];
   customerUserId?: string;
+  metadata?: string;
+  /**
+   * @deprecated
+   * Use metadata field instead.
+   */
   customerDescription?: string;
 }
 

package/src/core/selectors/selectorsByID.ts

@@ -384,3 +384,18 @@ export const selectPeersByRole = (role: HMSRoleName) =>
   createSelector([selectPeers], peers => {
     return peers.filter(p => p.roleName === role);
   });
+
+/**
+ * Selects the peer metadata for the passed in peer and returns it as JSON. If metadata is not present
+ * or conversion to JSON gives an error, an empty object is returned.
+ * Please directly use peer.metadata in case the metadata is not JSON by design.
+ */
+export const selectPeerMetadata = (peerId: HMSPeerID) =>
+  createSelector(selectPeerByID(peerId), peer => {
+    try {
+      return peer?.metadata && peer.metadata !== '' ? JSON.parse(peer.metadata) : {};
+    } catch (error) {
+      console.error('cannot parse peer metadata', error);
+      return {};
+    }
+  });

package/src/test/fakeStore.ts

@@ -85,6 +85,7 @@ export const makeFakeStore = (): HMSStore => {
         videoTrack: '101',
         audioTrack: '102',
         auxiliaryTracks: [],
+        metadata: '{}',
       },
       '2': {
         id: '2',
@@ -94,6 +95,7 @@ export const makeFakeStore = (): HMSStore => {
         videoTrack: '103',
         audioTrack: '104',
         auxiliaryTracks: ['105', '106', '107'],
+        metadata: '{"hello":"world"}',
       },
       '3': {
         id: '3',

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

@@ -68,6 +68,8 @@ import {
   selectAudioPlaylist,
   selectVideoPlaylist,
   selectPeersByRole,
+  selectPeers,
+  selectPeerMetadata,
 } from '../../core';
 
 let fakeStore: HMSStore;
@@ -292,6 +294,14 @@ describe('by ID selectors', () => {
     // If role is not present
     expect(selectPeersByRole('incognito')(fakeStore)).toEqual([]);
   });
+
+  test('selectPeerMetadata', () => {
+    const peers = selectPeers(fakeStore);
+    const metadata1 = selectPeerMetadata(peers[0].id)(fakeStore);
+    expect(metadata1).toEqual({});
+    const metadata2 = selectPeerMetadata(peers[1].id)(fakeStore);
+    expect(metadata2).toEqual({ hello: 'world' });
+  });
 });
 
 describe('derived selectors', () => {