feat: make HMSPeerType an enum

100mslive · Mar 27, 2024 · f9eb0e8 · f9eb0e8
1 parent 2660667
commit f9eb0e8
Show file tree

Hide file tree

Showing 6 changed files with 27 additions and 20 deletions.
diff --git a/packages/hms-video-store/src/interfaces/peer/hms-peer.ts b/packages/hms-video-store/src/interfaces/peer/hms-peer.ts
@@ -1,7 +1,10 @@
 import { HMSAudioTrack, HMSTrack, HMSVideoTrack } from '../../media/tracks';
 import { HMSRole } from '../role';
 
-export type HMSPeerType = 'sip' | 'regular';
+export enum HMSPeerType {
+  SIP = 'sip',
+  REGULAR = 'regular',
+}
 
 export interface HMSPeer {
   peerId: string;

diff --git a/packages/hms-video-store/src/interfaces/peer/index.ts b/packages/hms-video-store/src/interfaces/peer/index.ts
@@ -1,4 +1,5 @@
-export type { HMSPeer, HMSPeerType } from './hms-peer';
+export type { HMSPeer } from './hms-peer';
 export type { HMSLocalPeer } from './hms-local-peer';
 export type { HMSRemotePeer } from './hms-remote-peer';
 export type { HMSConnectionQuality } from './connection-quality';
+export { HMSPeerType } from './hms-peer';
diff --git a/packages/hms-video-store/src/notification-manager/fixtures.ts b/packages/hms-video-store/src/notification-manager/fixtures.ts
@@ -1,10 +1,11 @@
 import { MessageNotification, PeerListNotification, PeerNotification, SpeakerList } from './HMSNotifications';
+import { HMSPeerType } from '../interfaces';
 
 export const FAKE_PEER_ID = 'peer_id_1';
 
 export const fakePeer: PeerNotification = {
   peer_id: 'peer_id_0',
-  info: { data: 'data', name: 'Sarvesh0', user_id: 'customer_user_id', type: 'regular' },
+  info: { data: 'data', name: 'Sarvesh0', user_id: 'customer_user_id', type: HMSPeerType.REGULAR },
   role: 'host',
   tracks: {},
   groups: [],
@@ -17,7 +18,7 @@ export const fakePeerList: PeerListNotification = {
         name: 'Sarvesh1',
         data: 'data',
         user_id: 'customer_user_id',
-        type: 'regular',
+        type: HMSPeerType.REGULAR,
       },
       role: 'host',
       peer_id: FAKE_PEER_ID,
@@ -33,7 +34,7 @@ export const fakePeerList: PeerListNotification = {
         track_id_2: {
           mute: false,
           type: 'video',
-          source: 'regular',
+          source: HMSPeerType.REGULAR,
           description: '',
           track_id: 'track_id_2',
           stream_id: 'stream_id_1',
@@ -46,7 +47,7 @@ export const fakePeerList: PeerListNotification = {
         name: 'Sarvesh3',
         data: 'data',
         user_id: 'customer_user_id',
-        type: 'regular',
+        type: HMSPeerType.REGULAR,
       },
       peer_id: 'peer_id_3',
       role: 'viewer',
@@ -87,7 +88,7 @@ export const fakeReconnectPeerList: PeerListNotification = {
         name: 'Sarvesh1',
         data: 'data',
         user_id: 'customer_user_id',
-        type: 'regular',
+        type: HMSPeerType.REGULAR,
       },
       role: 'host',
       peer_id: FAKE_PEER_ID,
@@ -103,7 +104,7 @@ export const fakeReconnectPeerList: PeerListNotification = {
         track_id_2: {
           mute: false,
           type: 'video',
-          source: 'regular',
+          source: HMSPeerType.REGULAR,
           description: '',
           track_id: 'track_id_2',
           stream_id: 'stream_id_1',
@@ -116,7 +117,7 @@ export const fakeReconnectPeerList: PeerListNotification = {
         name: 'Sarvesh2',
         data: 'data',
         user_id: 'customer_user_id',
-        type: 'regular',
+        type: HMSPeerType.REGULAR,
       },
       peer_id: 'peer_id_2',
       role: 'viewer',

diff --git a/packages/hms-video-store/src/sdk/index.ts b/packages/hms-video-store/src/sdk/index.ts
@@ -28,6 +28,7 @@ import {
   HMSDeviceChangeEvent,
   HMSFrameworkInfo,
   HMSMessageInput,
+  HMSPeerType,
   HMSPlaylistSettings,
   HMSPlaylistType,
   HMSPreviewConfig,
@@ -1300,7 +1301,7 @@ export class HMSSdk implements HMSInterface {
       role: policy,
       // default value is the original role if user didn't pass asRole in config
       asRole: asRolePolicy || policy,
-      type: 'regular',
+      type: HMSPeerType.REGULAR,
     });
 
     this.store.addPeer(localPeer);

diff --git a/packages/hms-video-store/src/test/fakeStore/fakeHMSStore.ts b/packages/hms-video-store/src/test/fakeStore/fakeHMSStore.ts
@@ -9,7 +9,7 @@ import {
   HMSTrackSource,
   HMSTrackType,
 } from '../../';
-import { HMSSimulcastLayer } from '../../internal';
+import { HMSPeerType, HMSSimulcastLayer } from '../../internal';
 import { HMSAudioTrack, HMSPlaylist, HMSPlaylistType, HMSRole, HMSScreenVideoTrack, HMSVideoTrack } from '../../schema';
 
 function makeTrack(
@@ -98,7 +98,7 @@ export const makeFakeStore = (): HMSStore => {
         metadata: '{}',
         groups: [],
         isHandRaised: false,
-        type: 'regular',
+        type: HMSPeerType.REGULAR,
       },
       '2': {
         id: '2',
@@ -111,7 +111,7 @@ export const makeFakeStore = (): HMSStore => {
         metadata: '{"hello":"world"}',
         groups: [],
         isHandRaised: false,
-        type: 'regular',
+        type: HMSPeerType.REGULAR,
       },
       '3': {
         id: '3',
@@ -123,16 +123,16 @@ export const makeFakeStore = (): HMSStore => {
         auxiliaryTracks: [],
         groups: [],
         isHandRaised: false,
-        type: 'regular',
+        type: HMSPeerType.REGULAR,
       },
     },
     tracks: {
-      '101': makeTrack('101', 'video', 'regular', '1'),
-      '102': makeTrack('102', 'audio', 'regular', '1'),
-      '103': makeTrack('103', 'video', 'regular', '2'),
-      '104': makeTrack('104', 'audio', 'regular', '2'),
+      '101': makeTrack('101', 'video', HMSPeerType.REGULAR, '1'),
+      '102': makeTrack('102', 'audio', HMSPeerType.REGULAR, '1'),
+      '103': makeTrack('103', 'video', HMSPeerType.REGULAR, '2'),
+      '104': makeTrack('104', 'audio', HMSPeerType.REGULAR, '2'),
       '105': makeTrack('105', 'video', 'screen', '2'),
-      '106': makeTrack('106', 'audio', 'regular', '2'),
+      '106': makeTrack('106', 'audio', HMSPeerType.REGULAR, '2'),
       '107': makeTrack('107', 'audio', 'screen', '2'),
     },
     playlist: {

diff --git a/packages/hms-video-store/src/test/fixtures.ts b/packages/hms-video-store/src/test/fixtures.ts
@@ -1,3 +1,4 @@
+import { HMSPeerType } from '../interfaces';
 import { HMSAudioTrack, HMSPeer, HMSTrackType, HMSVideoTrack } from '../';
 
 let counter = 100;
@@ -20,6 +21,6 @@ export const makeFakePeer = (): HMSPeer => {
     videoTrack: '',
     groups: [],
     isHandRaised: false,
-    type: 'regular',
+    type: HMSPeerType.REGULAR,
   };
 };