STREAM-777: add new interface and rename params

Author: Aidan Zimmermann

src/client.ts

@@ -29,7 +29,7 @@ import {
   VideoMediaSession,
   IVideoResolution,
   JWTDetails,
-  ISdkFullConfig
+  ISdkFullConfig, LiveMonitoringMetadata
 } from './types/interfaces';
 import {
   setupStreamingClient,
@@ -410,14 +410,14 @@ export class GenesysCloudWebrtcSdk extends (EventEmitter as { new(): StrictEvent
    * `initialize()` must be called first.
    *
    * @param conferenceJid JID of the conference to join
-   * @param screenRecordingMetadatas Array of screen metadata to identify primary screen
+   * @param liveMonitoringMetadata Array of screen metadata to identify primary screen
    *
    * @returns a promise with an object with the newly created 'conversationId'
    */
-  async startLiveMonitoringSession (conferenceJid: string, screenRecordingMetadatas: ScreenRecordingMetadata[]): Promise<{ conversationId: string }> {
+  async startLiveMonitoringSession (conferenceJid: string, liveMonitoringMetadata: LiveMonitoringMetadata[]): Promise<{ conversationId: string }> {
     return this.sessionManager.startSession({
       conferenceJid,
-      screenRecordingMetadatas,
+      liveMonitoringMetadata,
       sessionType: SessionTypes.collaborateVideo
     });
   }

src/sessions/live-monitoring-session-handler.ts

@@ -2,8 +2,9 @@ import {
   IPendingSession,
   IExtendedMediaSession,
   IAcceptSessionRequest,
-  ScreenRecordingMetadata,
-  IUpdateOutgoingMedia, IStartScreenConferenceSessionParams,
+  LiveMonitoringMetadata,
+  IUpdateOutgoingMedia,
+  IStartLiveMonitoringSessionParams
 } from '../types/interfaces';
 import BaseSessionHandler from './base-session-handler';
 import { SessionTypes, SdkErrorTypes } from '../types/enums';
@@ -26,23 +27,20 @@ export class LiveMonitoringSessionHandler extends BaseSessionHandler {
     return this.proceedWithSession(pendingSession);
   }
 
-  async startSession(params: IStartScreenConferenceSessionParams): Promise<{ conversationId: string }> {
-    const primaryScreen = this.identifyPrimaryScreen(params.screenRecordingMetadatas);
-
+  async startSession(params: IStartLiveMonitoringSessionParams): Promise<{ conversationId: string }> {
+    const primaryScreen = this.identifyPrimaryScreen(params.liveMonitoringMetadata);
     if (!primaryScreen) {
       throw createAndEmitSdkError.call(this.sdk, SdkErrorTypes.invalid_options, 'No primary screen found in metadata');
     }
-
     const screenStream = await this.getScreenMediaForPrimary(primaryScreen);
-
     return this.joinConferenceWithScreen(params.conferenceJid, screenStream);
   }
 
-  private identifyPrimaryScreen(metadatas: ScreenRecordingMetadata[]): ScreenRecordingMetadata | null {
-    return metadatas.find(metadata => metadata.primary) || null;
+  private identifyPrimaryScreen(metadata: LiveMonitoringMetadata[]): LiveMonitoringMetadata | null {
+    return metadata.find(metadata => metadata.primary) || null;
   }
 
-  private async getScreenMediaForPrimary(primaryScreen: ScreenRecordingMetadata): Promise<MediaStream> {
+  private async getScreenMediaForPrimary(primaryScreen: LiveMonitoringMetadata): Promise<MediaStream> {
     try {
       const constraints = {
         video: {

src/sessions/session-manager.ts

@@ -21,7 +21,7 @@ import {
   IConversationHeldRequest,
   IPendingSessionActionParams,
   VideoMediaSession,
-  IActiveConversationDescription, IStartScreenConferenceSessionParams,
+  IActiveConversationDescription, IStartLiveMonitoringSessionParams,
   SubscriptionEvent
 } from '../types/interfaces';
 import { ConversationUpdate } from '../conversations/conversation-update';
@@ -187,7 +187,7 @@ export class SessionManager {
     return handler;
   }
 
-  async startSession (startSessionParams: IStartSessionParams | IStartVideoSessionParams | IStartVideoMeetingSessionParams | IStartSoftphoneSessionParams | IStartScreenConferenceSessionParams): Promise<any> {
+  async startSession (startSessionParams: IStartSessionParams | IStartVideoSessionParams | IStartVideoMeetingSessionParams | IStartSoftphoneSessionParams | IStartLiveMonitoringSessionParams): Promise<any> {
     if (!this.sdk.connected) {
       throw createAndEmitSdkError.call(this.sdk, SdkErrorTypes.session, 'A session cannot be started as streaming client is not yet connected', { sessionType: startSessionParams.sessionType });
     }

src/types/interfaces.ts

@@ -660,7 +660,7 @@ export interface IAcceptSessionRequest extends ISdkMediaDeviceIds {
   mediaStream?: MediaStream;
 
   /**
-   * metadata about screens and tracks. This is required for screen recording sessions
+   * metadata about screens and tracks. This is required for screen recording and live monitoring sessions
    */
   screenRecordingMetadatas?: ScreenRecordingMetadata[];
 
@@ -962,6 +962,10 @@ export interface ScreenRecordingMetadata {
   primary: boolean;
 }
 
+export interface LiveMonitoringMetadata extends ScreenRecordingMetadata {
+
+}
+
 export interface SubscriptionEvent {
   metadata: {
     correlationId: string;
@@ -1216,11 +1220,11 @@ export interface IStartSoftphoneSessionParams extends IStartSessionParams {
   uuiData?: string;
 }
 
-export interface IStartScreenConferenceSessionParams extends IStartSessionParams {
+export interface IStartLiveMonitoringSessionParams extends IStartSessionParams {
   /** Conference room JID to join */
   conferenceJid: string;
   /** Screen recording metadata to identify primary screen */
-  screenRecordingMetadatas: ScreenRecordingMetadata[];
+  liveMonitoringMetadata: LiveMonitoringMetadata[];
 }
 
 export interface ISdkSoftphoneDestination {

test/unit/client.test.ts

@@ -29,7 +29,9 @@ import {
   IStation,
   IPersonDetails,
   ISessionIdAndConversationId,
-  VideoSessionHandler, ScreenRecordingMetadata, IStartScreenConferenceSessionParams
+  VideoSessionHandler,
+  LiveMonitoringMetadata,
+  IStartLiveMonitoringSessionParams
 } from '../../src';
 import * as utils from '../../src/utils';
 import { RetryPromise } from 'genesys-cloud-streaming-client/dist/es/utils';
@@ -335,17 +337,17 @@ describe('Client', () => {
     it('should call session manager to start a live monitoring session', async () => {
       sdk = constructSdk();
       const conferenceJid = 'livemonitor@example.com';
-      const screenRecordingMetadatas = [{ screenId: 'screen1', primary: true } as ScreenRecordingMetadata];
+      const liveMonitoringMetadata = [{ screenId: 'screen1', primary: true } as LiveMonitoringMetadata];
 
       sessionManagerMock.startSession = jest.fn().mockResolvedValue({ conversationId: 'conv123' });
 
-      const result = await sdk.startLiveMonitoringSession(conferenceJid, screenRecordingMetadatas);
+      const result = await sdk.startLiveMonitoringSession(conferenceJid, liveMonitoringMetadata);
 
       expect(sessionManagerMock.startSession).toBeCalledWith({
         conferenceJid,
-        screenRecordingMetadatas,
+        liveMonitoringMetadata,
         sessionType: SessionTypes.collaborateVideo
-      } as IStartScreenConferenceSessionParams);
+      } as IStartLiveMonitoringSessionParams);
       expect(result).toEqual({ conversationId: 'conv123' });
     });
   });

test/unit/sessions/live-monitoring-session-handler.test.ts

@@ -124,7 +124,7 @@ describe('startSession', () => {
   it('should throw error if no primary screen found', async () => {
     const params = {
       conferenceJid: 'conf@example.com',
-      screenRecordingMetadatas: [{ screenId: 'screen1', primary: false }]
+      liveMonitoringMetadata: [{ screenId: 'screen1', primary: false }]
     };
 
     await expect(handler.startSession(params as any))
@@ -140,7 +140,7 @@ describe('startSession', () => {
 
     const params = {
       conferenceJid: 'conf@example.com',
-      screenRecordingMetadatas: mockMetadatas
+      liveMonitoringMetadata: mockMetadatas
     };
 
     const result = await handler.startSession(params as any);
@@ -165,7 +165,7 @@ describe('startSession', () => {
 
     const params = {
       conferenceJid: 'conf@example.com',
-      screenRecordingMetadatas: mockMetadatas
+      liveMonitoringMetadata: mockMetadatas
     };
 
     await expect(handler.startSession(params as any))
@@ -183,7 +183,7 @@ describe('startSession', () => {
 
     const params = {
       conferenceJid: 'conf@example.com',
-      screenRecordingMetadatas: mockMetadatas
+      liveMonitoringMetadata: mockMetadatas
     };
 
     await expect(handler.startSession(params as any))