@webex/plugin-meetings 3.1.0 → 3.2.0

package/package.json

@@ -28,7 +28,7 @@
     ]
   },
   "scripts": {
-    "build": "yarn run -T tsc --declaration true --declarationDir ./dist",
+    "build": "yarn run -T tsc --declaration true --declarationDir ./dist/types",
     "build:src": "webex-legacy-tools build -dest \"./dist\" -src \"./src\" -js -ts -maps && yarn build",
     "deploy:npm": "yarn npm publish",
     "test:broken": "yarn test:style && yarn test:unit && yarn test:integration && yarn test:browser",
@@ -43,13 +43,13 @@
     "@webex/eslint-config-legacy": "0.0.0",
     "@webex/jest-config-legacy": "0.0.0",
     "@webex/legacy-tools": "0.0.0",
-    "@webex/plugin-meetings": "3.1.0",
-    "@webex/plugin-rooms": "3.1.0",
-    "@webex/test-helper-chai": "3.1.0",
-    "@webex/test-helper-mocha": "3.1.0",
-    "@webex/test-helper-mock-webex": "3.1.0",
-    "@webex/test-helper-retry": "3.1.0",
-    "@webex/test-helper-test-users": "3.1.0",
+    "@webex/plugin-meetings": "3.2.0",
+    "@webex/plugin-rooms": "3.2.0",
+    "@webex/test-helper-chai": "3.2.0",
+    "@webex/test-helper-mocha": "3.2.0",
+    "@webex/test-helper-mock-webex": "3.2.0",
+    "@webex/test-helper-retry": "3.2.0",
+    "@webex/test-helper-test-users": "3.2.0",
     "chai": "^4.3.4",
     "chai-as-promised": "^7.1.1",
     "eslint": "^8.24.0",
@@ -61,20 +61,20 @@
     "typescript": "^4.7.4"
   },
   "dependencies": {
-    "@webex/common": "3.1.0",
+    "@webex/common": "3.2.0",
     "@webex/internal-media-core": "2.5.0",
-    "@webex/internal-plugin-conversation": "3.1.0",
-    "@webex/internal-plugin-device": "3.1.0",
-    "@webex/internal-plugin-llm": "3.1.0",
-    "@webex/internal-plugin-mercury": "3.1.0",
-    "@webex/internal-plugin-metrics": "3.1.0",
-    "@webex/internal-plugin-support": "3.1.0",
-    "@webex/internal-plugin-user": "3.1.0",
-    "@webex/internal-plugin-voicea": "3.1.0",
-    "@webex/media-helpers": "3.1.0",
-    "@webex/plugin-people": "3.1.0",
-    "@webex/plugin-rooms": "3.1.0",
-    "@webex/webex-core": "3.1.0",
+    "@webex/internal-plugin-conversation": "3.2.0",
+    "@webex/internal-plugin-device": "3.2.0",
+    "@webex/internal-plugin-llm": "3.2.0",
+    "@webex/internal-plugin-mercury": "3.2.0",
+    "@webex/internal-plugin-metrics": "3.2.0",
+    "@webex/internal-plugin-support": "3.2.0",
+    "@webex/internal-plugin-user": "3.2.0",
+    "@webex/internal-plugin-voicea": "3.2.0",
+    "@webex/media-helpers": "3.2.0",
+    "@webex/plugin-people": "3.2.0",
+    "@webex/plugin-rooms": "3.2.0",
+    "@webex/webex-core": "3.2.0",
     "ampersand-collection": "^2.0.2",
     "bowser": "^2.11.0",
     "btoa": "^1.2.1",
@@ -91,5 +91,5 @@
   "//": [
     "TODO: upgrade jwt-decode when moving to node 18"
   ],
-  "version": "3.1.0"
+  "version": "3.2.0"
 }

package/src/common/errors/reconnection-not-started.ts

@@ -0,0 +1,25 @@
+import {ERROR_DICTIONARY} from '../../constants';
+import ReconnectionError from './reconnection';
+
+/**
+ * Error object for cases when new reconnection cannot be started
+ */
+export default class ReconnectionNotStartedError extends ReconnectionError {
+  /**
+   *
+   * @constructor
+   * @param {String} [message]
+   * @param {Object} [error]
+   */
+  constructor(
+    message: string = ERROR_DICTIONARY.RECONNECTION_NOT_STARTED.MESSAGE,
+    error: any = null
+  ) {
+    super(message, error);
+    this.name = ERROR_DICTIONARY.RECONNECTION_NOT_STARTED.NAME;
+    this.sdkMessage = ERROR_DICTIONARY.RECONNECTION_NOT_STARTED.MESSAGE;
+    this.error = error;
+    this.stack = error ? error.stack : new Error().stack;
+    this.code = ERROR_DICTIONARY.RECONNECTION_NOT_STARTED.CODE;
+  }
+}

package/src/constants.ts

@@ -100,7 +100,7 @@ export const _JOINED_ = 'JOINED';
 export const _LOCUS_ID_ = 'LOCUS_ID';
 export const _LEFT_ = 'LEFT';
 export const _MOVED_ = 'MOVED';
-
+export const _ON_HOLD_LOBBY_ = 'ON_HOLD_LOBBY';
 export const _MEETING_LINK_ = 'MEETING_LINK';
 export const _MEETING_UUID_ = 'MEETING_UUID';
 export const _MEETING_ = 'MEETING';
@@ -380,7 +380,7 @@ export const EVENT_TRIGGERS = {
   MEETING_TRANSCRIPTION_CONNECTED: 'meeting:transcription:connected',
   MEETING_STARTED_RECEIVING_TRANSCRIPTION: 'meeting:receiveTranscription:started',
   MEETING_STOPPED_RECEIVING_TRANSCRIPTION: 'meeting:receiveTranscription:stopped',
-
+  MEETING_MANUAL_CAPTION_UPDATED: 'meeting:manualCaptionControl:updated',
   MEETING_CAPTION_RECEIVED: 'meeting:caption-received',
 };
 
@@ -535,6 +535,12 @@ export const ERROR_DICTIONARY = {
       'Participant Having Host Role Already. Participant who sends request to reclaim host role has already a host role.',
     CODE: 14,
   },
+  RECONNECTION_NOT_STARTED: {
+    NAME: 'ReconnectionNotStartedError',
+    MESSAGE:
+      'Reconnection was not started, because there is one already in progress or reconnections are disabled in config.',
+    CODE: 15,
+  },
 };
 
 export const FLOOR_ACTION = {
@@ -671,6 +677,7 @@ export const LOCUSINFO = {
     CONTROLS_MEETING_LAYOUT_UPDATED: 'CONTROLS_MEETING_LAYOUT_UPDATED',
     CONTROLS_RECORDING_UPDATED: 'CONTROLS_RECORDING_UPDATED',
     CONTROLS_MEETING_TRANSCRIBE_UPDATED: 'CONTROLS_MEETING_TRANSCRIBE_UPDATED',
+    CONTROLS_MEETING_MANUAL_CAPTION_UPDATED: 'CONTROLS_MEETING_MANUAL_CAPTION_UPDATED',
     CONTROLS_MEETING_BREAKOUT_UPDATED: 'CONTROLS_MEETING_BREAKOUT_UPDATED',
     CONTROLS_MEETING_CONTAINER_UPDATED: 'CONTROLS_MEETING_CONTAINER_UPDATED',
     CONTROLS_MEETING_INTERPRETATION_UPDATED: 'CONTROLS_MEETING_INTERPRETATION_UPDATED',
@@ -909,6 +916,9 @@ export const DISPLAY_HINTS = {
   LEAVE_END_MEETING: 'LEAVE_END_MEETING',
   CAPTION_START: 'CAPTION_START',
   CAPTION_STATUS_ACTIVE: 'CAPTION_STATUS_ACTIVE',
+  MANUAL_CAPTION_START: 'MANUAL_CAPTION_START',
+  MANUAL_CAPTION_STOP: 'MANUAL_CAPTION_STOP',
+  MANUAL_CAPTION_STATUS_ACTIVE: 'MANUAL_CAPTION_STATUS_ACTIVE',
   DISPLAY_REAL_TIME_TRANSLATION: 'DISPLAY_REAL_TIME_TRANSLATION',
   ENABLE_CAPTION_PANEL: 'ENABLE_CAPTION_PANEL',
   DISPLAY_NON_ENGLISH_ASR: 'DISPLAY_NON_ENGLISH_ASR',
@@ -1043,9 +1053,7 @@ export const PEER_CONNECTION_STATE = {
 export const RECONNECTION = {
   STATE: {
     IN_PROGRESS: 'IN_PROGRESS',
-    COMPLETE: 'COMPLETE',
     FAILURE: 'FAILURE',
-    DEFAULT_TRY_COUNT: 0,
     DEFAULT_STATUS: '',
   },
 } as const;
@@ -1114,6 +1122,8 @@ export const MQA_STATS = {
         direction: 'sendrecv', // TODO: parse from SDP and save globally
         isMain: false, // always true for share sender
         mariFecEnabled: false, // unavailable
+        mariRtxEnabled: false, // unavailable
+        mariLiteEnabled: false, // unavailable
         mariQosEnabled: false, // unavailable
         multistreamEnabled: false, // unavailable
       },
@@ -1126,7 +1136,6 @@ export const MQA_STATS = {
       queueDelay: 0, // unavailable
       remoteJitter: 0, // unavailable
       remoteLossRate: 0,
-      remoteReceiveRate: 0, // unavailable
       roundTripTime: 0,
       rtcpBitrate: 0, // unavailable
       rtcpPackets: 0, // unavailable

package/src/index.ts

@@ -4,6 +4,19 @@ import {registerPlugin} from '@webex/webex-core';
 import Meetings from './meetings';
 import config from './config';
 import {LocusRetryStatusInterceptor} from './interceptors';
+import CaptchaError from './common/errors/captcha-error';
+import IntentToJoinError from './common/errors/intent-to-join';
+import PasswordError from './common/errors/password-error';
+import PermissionError from './common/errors/permission';
+import {
+  ReclaimHostEmptyWrongKeyError,
+  ReclaimHostIsHostAlreadyError,
+  ReclaimHostNotAllowedError,
+  ReclaimHostNotSupportedError,
+} from './common/errors/reclaim-host-role-errors';
+import Meeting from './meeting';
+import MeetingInfoUtil from './meeting-info/utilv2';
+import JoinMeetingError from './common/errors/join-meeting';
 
 registerPlugin('meetings', Meetings, {
   config,
@@ -39,6 +52,23 @@ export default Meetings;
 
 export * as CONSTANTS from './constants';
 export * as REACTIONS from './reactions/reactions';
+export * as sdkAnnotationTypes from './annotation/annotation.types';
+export * as MeetingInfoV2 from './meeting-info/meeting-info-v2';
+export {type Reaction} from './reactions/reactions.type';
+
+export {
+  CaptchaError,
+  IntentToJoinError,
+  JoinMeetingError,
+  PasswordError,
+  PermissionError,
+  ReclaimHostIsHostAlreadyError,
+  ReclaimHostNotAllowedError,
+  ReclaimHostNotSupportedError,
+  ReclaimHostEmptyWrongKeyError,
+  Meeting,
+  MeetingInfoUtil,
+};
 
 export {RemoteMedia} from './multistream/remoteMedia';
 

package/src/locus-info/controlsUtils.ts

@@ -43,6 +43,12 @@ ControlsUtils.parse = (controls: any) => {
     };
   }
 
+  if (controls && controls.manualCaptionControl) {
+    parsedControls.manualCaptionControl = {
+      enabled: controls.manualCaptionControl.enabled,
+    };
+  }
+
   if (controls && controls.entryExitTone) {
     parsedControls.entryExitTone = controls.entryExitTone.enabled
       ? controls.entryExitTone.mode
@@ -143,6 +149,11 @@ ControlsUtils.getControls = (oldControls: any, newControls: any) => {
         !isEqual(previous?.transcribe?.transcribing, current?.transcribe?.transcribing) && // upon first join, previous?.record?.recording = undefined; thus, never going to be equal and will always return true
         (previous?.transcribe?.transcribing || current?.transcribe?.transcribing), // therefore, condition added to prevent false firings of #meeting:recording:stopped upon first joining a meeting
 
+      hasManualCaptionChanged:
+        current?.manualCaptionControl &&
+        !isEqual(previous?.manualCaptionControl?.enabled, current?.manualCaptionControl?.enabled) &&
+        (previous?.manualCaptionControl?.enabled || current?.manualCaptionControl?.enabled),
+
       hasEntryExitToneChanged: !!(
         newControls.entryExitTone &&
         !isEqual(previous?.entryExitTone, current?.entryExitTone) &&

package/src/locus-info/index.ts

@@ -792,6 +792,7 @@ export default class LocusInfo extends EventsScope {
           hasRecordingPausedChanged,
           hasMeetingContainerChanged,
           hasTranscribeChanged,
+          hasManualCaptionChanged,
           hasEntryExitToneChanged,
           hasBreakoutChanged,
           hasVideoEnabledChanged,
@@ -923,6 +924,21 @@ export default class LocusInfo extends EventsScope {
         );
       }
 
+      if (hasManualCaptionChanged) {
+        const {enabled} = current.manualCaptionControl;
+
+        this.emitScoped(
+          {
+            file: 'locus-info',
+            function: 'updateControls',
+          },
+          LOCUSINFO.EVENTS.CONTROLS_MEETING_MANUAL_CAPTION_UPDATED,
+          {
+            enabled,
+          }
+        );
+      }
+
       if (hasBreakoutChanged) {
         const {breakout} = current;
         breakout.breakoutMoveId = SelfUtils.getReplacedBreakoutMoveId(

package/src/media/properties.ts

@@ -1,3 +1,4 @@
+/* eslint-disable class-methods-use-this */
 import {
   LocalCameraStream,
   LocalMicrophoneStream,
@@ -182,25 +183,45 @@ export default class MediaProperties {
   }
 
   /**
-   * Returns the type of a connection that has been established
+   * Returns ICE transport information:
+   * - selectedCandidatePairChanges - number of times the selected candidate pair was changed, it should be at least 1 for successful connections
+   *  it will be -1 if browser doesn't supply this information
+   * - numTransports - number of transports (should be 1 if we're using bundle)
    *
-   * @returns {Promise<'UDP' | 'TCP' | 'TURN-TLS' | 'TURN-TCP' | 'TURN-UDP' | 'unknown'>}
+   * @param {Array<any>} allStatsReports array of RTC stats reports
+   * @returns {Object}
    */
-  async getCurrentConnectionType() {
-    // we can only get the connection type after ICE connection has been established
-    await this.waitForMediaConnectionConnected();
-
-    const allStatsReports = [];
+  private getTransportInfo(allStatsReports: any[]): {
+    selectedCandidatePairChanges: number;
+    numTransports: number;
+  } {
+    const transports = allStatsReports.filter((report) => report.type === 'transport');
 
-    try {
-      const statsResult = await this.webrtcMediaConnection.getStats();
-      statsResult.forEach((report) => allStatsReports.push(report));
-    } catch (error) {
+    if (transports.length > 1) {
       LoggerProxy.logger.warn(
-        `Media:properties#getCurrentConnectionType --> getStats() failed: ${error}`
+        `Media:properties#getSelectedCandidatePairChanges --> found more than 1 transport: ${transports.length}`
       );
     }
 
+    return {
+      selectedCandidatePairChanges:
+        transports.length > 0 && transports[0].selectedCandidatePairChanges !== undefined
+          ? transports[0].selectedCandidatePairChanges
+          : -1,
+      numTransports: transports.length,
+    };
+  }
+
+  /**
+   * Returns the type of a connection that has been established
+   * It should be 'UDP' | 'TCP' | 'TURN-TLS' | 'TURN-TCP' | 'TURN-UDP' | 'unknown'
+   *
+   * If connection was not established, it returns 'unknown'
+   *
+   * @param {Array<any>} allStatsReports array of RTC stats reports
+   * @returns {string}
+   */
+  private getConnectionType(allStatsReports: any[]) {
     const successfulCandidatePairs = allStatsReports.filter(
       (report) => report.type === 'candidate-pair' && report.state?.toLowerCase() === 'succeeded'
     );
@@ -215,7 +236,7 @@ export default class MediaProperties {
 
       if (localCandidate === undefined) {
         LoggerProxy.logger.warn(
-          `Media:properties#getCurrentConnectionType --> failed to find local candidate "${pair.localCandidateId}" in getStats() results`
+          `Media:properties#getConnectionType --> failed to find local candidate "${pair.localCandidateId}" in getStats() results`
         );
 
         return false;
@@ -235,7 +256,7 @@ export default class MediaProperties {
         return true;
       }
       LoggerProxy.logger.warn(
-        `Media:properties#getCurrentConnectionType --> missing localCandidate.protocol, candidateType=${localCandidate.candidateType}`
+        `Media:properties#getConnectionType --> missing localCandidate.protocol, candidateType=${localCandidate.candidateType}`
       );
 
       return false;
@@ -247,7 +268,7 @@ export default class MediaProperties {
         .map((report) => report.state);
 
       LoggerProxy.logger.warn(
-        `Media:properties#getCurrentConnectionType --> all candidate pair states: ${JSON.stringify(
+        `Media:properties#getConnectionType --> all candidate pair states: ${JSON.stringify(
           candidatePairStates
         )}`
       );
@@ -255,4 +276,35 @@ export default class MediaProperties {
 
     return foundConnectionType;
   }
+
+  /**
+   * Returns information about current webrtc media connection
+   *
+   * @returns {Promise<Object>}
+   */
+  async getCurrentConnectionInfo(): Promise<{
+    connectionType: string;
+    selectedCandidatePairChanges: number;
+    numTransports: number;
+  }> {
+    const allStatsReports = [];
+
+    try {
+      const statsResult = await this.webrtcMediaConnection.getStats();
+      statsResult.forEach((report) => allStatsReports.push(report));
+    } catch (error) {
+      LoggerProxy.logger.warn(
+        `Media:properties#getCurrentConnectionInfo --> getStats() failed: ${error}`
+      );
+    }
+
+    const connectionType = this.getConnectionType(allStatsReports);
+    const {selectedCandidatePairChanges, numTransports} = this.getTransportInfo(allStatsReports);
+
+    return {
+      connectionType,
+      selectedCandidatePairChanges,
+      numTransports,
+    };
+  }
 }

package/src/mediaQualityMetrics/config.ts

@@ -21,7 +21,9 @@ export const emptyAudioReceive = {
       direction: 'inactive',
       isMain: true,
       mariFecEnabled: false,
+      mariRtxEnabled: false,
       mariQosEnabled: false,
+      mariLiteEnabled: false,
       multistreamEnabled: false,
     },
     dtlsBitrate: 0,
@@ -75,7 +77,9 @@ export const emptyAudioTransmit = {
       direction: 'inactive',
       isMain: true,
       mariFecEnabled: false,
+      mariRtxEnabled: false,
       mariQosEnabled: false,
+      mariLiteEnabled: false,
       multistreamEnabled: false,
     },
     dtlsBitrate: 0,
@@ -86,7 +90,6 @@ export const emptyAudioTransmit = {
     queueDelay: 0,
     remoteJitter: 0,
     remoteLossRate: 0,
-    remoteReceiveRate: 0,
     roundTripTime: 0,
     rtcpBitrate: 0,
     rtcpPackets: 0,
@@ -119,8 +122,10 @@ export const emptyVideoReceive = {
     common: {
       direction: 'inactive',
       isMain: true, // Not avaliable
-      mariFecEnabled: true, // Not avaliable
-      mariQosEnabled: true, // Not avaliable
+      mariFecEnabled: false,
+      mariRtxEnabled: false,
+      mariQosEnabled: false,
+      mariLiteEnabled: false,
       multistreamEnabled: true, // Not avaliable
     },
     dtlsBitrate: 0, // Not avaliable
@@ -184,8 +189,10 @@ export const emptyVideoTransmit = {
     common: {
       direction: 'inactive',
       isMain: true,
-      mariFecEnabled: false, // Not avaliable
-      mariQosEnabled: false, // Not avaliable
+      mariFecEnabled: false,
+      mariRtxEnabled: false,
+      mariQosEnabled: false,
+      mariLiteEnabled: false,
       multistreamEnabled: false, // Not avaliable
     },
     dtlsBitrate: 0, // Not avaliable
@@ -193,10 +200,9 @@ export const emptyVideoTransmit = {
     fecBitrate: 0, // Not avaliable
     fecPackets: 0, // TODO: check inbound-rtp// Not avaliable
     maxBitrate: 0, // Currently hardcoded
-    queueDelay: 0, // outboundRtp.totalPacketSentDelay  // TODO: check if totalInterFrameDelay/ packetSentDelay/ jitterBufferDalay
+    queueDelay: 0,
     remoteJitter: 0, // remoteInboundRtp.jitter
     remoteLossRate: 0, // comparedResults.lossRate
-    remoteReceiveRate: 0, // compareResults.packetsLost
     roundTripTime: 0, // compareResults.roundTripTime
     rtcpBitrate: 0, // Dont have access to it
     rtcpPackets: 0, // Dont have access to rtcp

package/src/meeting/in-meeting-actions.ts

@@ -34,6 +34,9 @@ interface IInMeetingActions {
   canStartTranscribing?: boolean;
   canStopTranscribing?: boolean;
   isClosedCaptionActive?: boolean;
+  canStartManualCaption?: boolean;
+  canStopManualCaption?: boolean;
+  isManualCaptionActive?: boolean;
   isSaveTranscriptsEnabled?: boolean;
   isWebexAssistantActive?: boolean;
   canViewCaptionPanel?: boolean;
@@ -137,6 +140,12 @@ export default class InMeetingActions implements IInMeetingActions {
 
   isClosedCaptionActive = null;
 
+  canStartManualCaption = null;
+
+  canStopManualCaption = null;
+
+  isManualCaptionActive = null;
+
   isSaveTranscriptsEnabled = null;
 
   isWebexAssistantActive = null;
@@ -257,6 +266,9 @@ export default class InMeetingActions implements IInMeetingActions {
     canStartTranscribing: this.canStartTranscribing,
     canStopTranscribing: this.canStopTranscribing,
     isClosedCaptionActive: this.isClosedCaptionActive,
+    canStartManualCaption: this.canStartManualCaption,
+    canStopManualCaption: this.canStopManualCaption,
+    isManualCaptionActive: this.isManualCaptionActive,
     isSaveTranscriptsEnabled: this.isSaveTranscriptsEnabled,
     isWebexAssistantActive: this.isWebexAssistantActive,
     canViewCaptionPanel: this.canViewCaptionPanel,