@webex/plugin-meetings 3.8.0-next.6 → 3.8.0-next.61

package/package.json

@@ -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.8.0-next.6",
-    "@webex/plugin-rooms": "3.8.0-next.1",
-    "@webex/test-helper-chai": "3.8.0-next.1",
-    "@webex/test-helper-mocha": "3.8.0-next.1",
-    "@webex/test-helper-mock-webex": "3.8.0-next.1",
-    "@webex/test-helper-retry": "3.8.0-next.1",
-    "@webex/test-helper-test-users": "3.8.0-next.1",
+    "@webex/plugin-meetings": "3.8.0-next.61",
+    "@webex/plugin-rooms": "3.8.0-next.21",
+    "@webex/test-helper-chai": "3.8.0-next.17",
+    "@webex/test-helper-mocha": "3.8.0-next.17",
+    "@webex/test-helper-mock-webex": "3.8.0-next.17",
+    "@webex/test-helper-retry": "3.8.0-next.17",
+    "@webex/test-helper-test-users": "3.8.0-next.17",
     "chai": "^4.3.4",
     "chai-as-promised": "^7.1.1",
     "eslint": "^8.24.0",
@@ -61,22 +61,22 @@
     "typescript": "^4.7.4"
   },
   "dependencies": {
-    "@webex/common": "3.8.0-next.1",
-    "@webex/event-dictionary-ts": "^1.0.1688",
-    "@webex/internal-media-core": "2.14.4",
-    "@webex/internal-plugin-conversation": "3.8.0-next.1",
-    "@webex/internal-plugin-device": "3.8.0-next.1",
-    "@webex/internal-plugin-llm": "3.8.0-next.2",
-    "@webex/internal-plugin-mercury": "3.8.0-next.1",
-    "@webex/internal-plugin-metrics": "3.8.0-next.1",
-    "@webex/internal-plugin-support": "3.8.0-next.1",
-    "@webex/internal-plugin-user": "3.8.0-next.1",
-    "@webex/internal-plugin-voicea": "3.8.0-next.6",
-    "@webex/media-helpers": "3.8.0-next.1",
-    "@webex/plugin-people": "3.8.0-next.1",
-    "@webex/plugin-rooms": "3.8.0-next.1",
+    "@webex/common": "3.8.0-next.17",
+    "@webex/event-dictionary-ts": "^1.0.1753",
+    "@webex/internal-media-core": "2.16.0",
+    "@webex/internal-plugin-conversation": "3.8.0-next.21",
+    "@webex/internal-plugin-device": "3.8.0-next.17",
+    "@webex/internal-plugin-llm": "3.8.0-next.20",
+    "@webex/internal-plugin-mercury": "3.8.0-next.19",
+    "@webex/internal-plugin-metrics": "3.8.0-next.17",
+    "@webex/internal-plugin-support": "3.8.0-next.21",
+    "@webex/internal-plugin-user": "3.8.0-next.17",
+    "@webex/internal-plugin-voicea": "3.8.0-next.61",
+    "@webex/media-helpers": "3.8.0-next.21",
+    "@webex/plugin-people": "3.8.0-next.19",
+    "@webex/plugin-rooms": "3.8.0-next.21",
     "@webex/web-capabilities": "^1.4.0",
-    "@webex/webex-core": "3.8.0-next.1",
+    "@webex/webex-core": "3.8.0-next.17",
     "ampersand-collection": "^2.0.2",
     "bowser": "^2.11.0",
     "btoa": "^1.2.1",
@@ -92,5 +92,5 @@
   "//": [
     "TODO: upgrade jwt-decode when moving to node 18"
   ],
-  "version": "3.8.0-next.6"
+  "version": "3.8.0-next.61"
 }

package/src/common/errors/webex-errors.ts

@@ -152,12 +152,19 @@ WebExMeetingsErrors[IceGatheringFailed.CODE] = IceGatheringFailed;
  * @extends WebexMeetingsError
  * @property {number} code - 30203
  * @property {string} message - 'Failed to add media'
+ * @property {Error} [cause] - The underlying error that caused the failure
  */
 class AddMediaFailed extends WebexMeetingsError {
   static CODE = 30203;
+  cause?: Error;
 
-  constructor() {
+  /**
+   * Creates a new AddMediaFailed error
+   * @param {Error} [cause] - The underlying error that caused the media addition to fail
+   */
+  constructor(cause?: Error) {
     super(AddMediaFailed.CODE, 'Failed to add media');
+    this.cause = cause;
   }
 }
 export {AddMediaFailed};

package/src/config.ts

@@ -95,6 +95,7 @@ export default {
     // This only applies to non-multistream meetings
     iceCandidatesGatheringTimeout: undefined,
     backendIpv6NativeSupport: false,
+    enableReachabilityChecks: true,
     reachabilityGetClusterTimeout: 5000,
     logUploadIntervalMultiplicationFactor: 0, // if set to 0 or undefined, logs won't be uploaded periodically, if you want periodic logs, recommended value is 1
   },

package/src/constants.ts

@@ -369,6 +369,9 @@ export const EVENT_TRIGGERS = {
   MEETING_CONTROLS_MEETING_FULL_UPDATED: 'meeting:controls:meeting-full:updated',
   MEETING_CONTROLS_PRACTICE_SESSION_STATUS_UPDATED:
     'meeting:controls:practice-session-status:updated',
+  MEETING_CONTROLS_ANNOTATION_UPDATED: 'meeting:controls:annotation:updated',
+  MEETING_CONTROLS_REMOTE_DESKTOP_CONTROL_UPDATED:
+    'meeting:controls:remote-desktop-control:updated',
   // Locus URL changed
   MEETING_LOCUS_URL_UPDATE: 'meeting:locus:locusUrl:update',
   MEETING_STREAM_PUBLISH_STATE_CHANGED: 'meeting:streamPublishStateChanged',
@@ -711,6 +714,8 @@ export const LOCUSINFO = {
     CONTROLS_PRACTICE_SESSION_STATUS_UPDATED: 'CONTROLS_PRACTICE_SESSION_STATUS_UPDATED',
     CONTROLS_VIDEO_CHANGED: 'CONTROLS_VIDEO_CHANGED',
     CONTROLS_STAGE_VIEW_UPDATED: 'CONTROLS_STAGE_VIEW_UPDATED',
+    CONTROLS_ANNOTATION_CHANGED: 'CONTROLS_ANNOTATION_CHANGED',
+    CONTROLS_REMOTE_DESKTOP_CONTROL_CHANGED: 'CONTROLS_REMOTE_DESKTOP_CONTROL_CHANGED',
     SELF_UNADMITTED_GUEST: 'SELF_UNADMITTED_GUEST',
     SELF_ADMITTED_GUEST: 'SELF_ADMITTED_GUEST',
     SELF_REMOTE_VIDEO_MUTE_STATUS_UPDATED: 'SELF_REMOTE_VIDEO_MUTE_STATUS_UPDATED',
@@ -904,7 +909,9 @@ export enum SELF_POLICY {
   ENFORCE_VIRTUAL_BACKGROUND = 'enforceVirtualBackground',
   SUPPORT_LOCAL_RECORD = 'supportLocalRecord',
   SUPPORT_NETWORK_BASED_RECORD = 'supportNetworkBasedRecord',
+  SUPPORT_PREMISE_RECORD = 'supportPremiseRecord',
   SUPPORT_REALTIME_CLOSE_CAPTION = 'supportRealtimeCloseCaption',
+  SUPPORT_REALTIME_CLOSE_CAPTION_MANUAL = 'supportRealtimeCloseCaptionManual',
   SUPPORT_CHAT = 'supportChat',
   SUPPORT_DESKTOP_SHARE_REMOTE = 'supportDesktopShareRemote',
   SUPPORT_DESKTOP_SHARE = 'supportDesktopShare',
@@ -972,6 +979,7 @@ export const DISPLAY_HINTS = {
   PRESENTER_CONTROL: 'PRESENTER_CONTROL',
   CAN_RENAME_SELF_AND_OBSERVED: 'CAN_RENAME_SELF_AND_OBSERVED',
   CAN_RENAME_OTHERS: 'CAN_RENAME_OTHERS',
+  MOVE_TO_LOBBY: 'MOVE_TO_LOBBY',
 
   // breakout session
   BREAKOUT_MANAGEMENT: 'BREAKOUT_MANAGEMENT',
@@ -1025,6 +1033,17 @@ export const DISPLAY_HINTS = {
   PRACTICE_SESSION_OFF: 'PRACTICE_SESSION_OFF',
   SHOW_PRACTICE_SESSION_START: 'SHOW_PRACTICE_SESSION_START',
   SHOW_PRACTICE_SESSION_STOP: 'SHOW_PRACTICE_SESSION_STOP',
+
+  // Explicit consent for post meeting data
+  SHOW_POST_MEETING_DATA_CONSENT_PROMPT: 'SHOW_POST_MEETING_DATA_CONSENT_PROMPT',
+
+  // Annotations
+  ENABLE_ANNOTATION_MEETING_OPTION: 'ENABLE_ANNOTATION_MEETING_OPTION',
+  DISABLE_ANNOTATION_MEETING_OPTION: 'DISABLE_ANNOTATION_MEETING_OPTION',
+
+  // Remote Desktop Control
+  ENABLE_RDC_MEETING_OPTION: 'ENABLE_RDC_MEETING_OPTION',
+  DISABLE_RDC_MEETING_OPTION: 'DISABLE_RDC_MEETING_OPTION',
 };
 
 export const INTERSTITIAL_DISPLAY_HINTS = [DISPLAY_HINTS.VOIP_IS_ENABLED];
@@ -1149,96 +1168,6 @@ export const NETWORK_STATUS = {
 
 export type NETWORK_STATUS = Enum<typeof NETWORK_STATUS>;
 
-export const NETWORK_TYPE = {
-  VPN: 'vpn',
-  UNKNOWN: 'unknown',
-  WIFI: 'wifi',
-  ETHERNET: 'ethernet',
-};
-
-export const STATS = {
-  SEND_DIRECTION: 'send',
-  RECEIVE_DIRECTION: 'recv',
-  REMOTE: 'remote',
-  LOCAL: 'local',
-};
-
-export const MQA_STATS = {
-  MQA_SIZE: 120, // MQA is done on 60 second intervals by server def, add a buffer for missed events
-  CA_TYPE: 'MQA',
-  DEFAULT_IP: '0.0.0.0',
-  DEFAULT_SHARE_SENDER_STATS: {
-    common: {
-      common: {
-        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
-      },
-      availableBitrate: 0,
-      dtlsBitrate: 0, // unavailable
-      dtlsPackets: 0, // unavailable
-      fecBitrate: 0, // unavailable
-      fecPackets: 0, // unavailable
-      maxBitrate: 0, // unavailable
-      queueDelay: 0, // unavailable
-      remoteJitter: 0, // unavailable
-      remoteLossRate: 0,
-      roundTripTime: 0,
-      rtcpBitrate: 0, // unavailable
-      rtcpPackets: 0, // unavailable
-      rtpBitrate: 0, // unavailable
-      rtpPackets: 0,
-      stunBitrate: 0, // unavailable
-      stunPackets: 0, // unavailable
-      transportType: 'UDP', // TODO: parse the transport type from the SDP and save globally
-    },
-    streams: [
-      {
-        common: {
-          codec: 'H264', // TODO: parse the codec from the SDP and save globally
-          duplicateSsci: 0, // unavailable
-          requestedBitrate: 0, // unavailable
-          requestedFrames: 0, // unavailable
-          rtpPackets: 0,
-          ssci: 0, // unavailable
-          transmittedBitrate: 0,
-          transmittedFrameRate: 0,
-        },
-        h264CodecProfile: 'BP', // TODO: parse the profile level from h264 in the SDP and save globally
-        localConfigurationChanges: 0, // unavailable
-        remoteConfigurationChanges: 0, // unavailable
-        requestedFrameSize: 0, // unavailable
-        requestedKeyFrames: 0, // unavailable
-        transmittedFrameSize: 0, // unavailable
-        transmittedHeight: 0,
-        transmittedKeyFrames: 0,
-        transmittedWidth: 0,
-      },
-    ],
-  },
-  intervalMetadata: {
-    memoryUsage: {
-      cpuBitWidth: 0,
-      mainProcessMaximumMemoryBytes: 0,
-      osBitWidth: 0,
-      processAverageMemoryUsage: 0,
-      processMaximumMemoryBytes: 0,
-      processMaximumMemoryUsage: 0,
-      systemAverageMemoryUsage: 0,
-      systemMaximumMemoryUsage: 0,
-    },
-    peerReflexiveIP: 'NULL', // TODO: save after ice trickling completes and use as a global variable
-    processAverageCPU: 0,
-    processMaximumCPU: 0,
-    systemAverageCPU: 0,
-    systemMaximumCPU: 0,
-  },
-};
-
 // ****** MEDIA QUALITY CONSTANTS ****** //
 
 // these values must match allowed values of RemoteQualityLevel from the @webex/internal-media-core lib

package/src/controls-options-manager/enums.ts

@@ -12,6 +12,8 @@ enum Control {
   shareControl = 'shareControl',
   video = 'video',
   viewTheParticipantList = 'viewTheParticipantList',
+  annotation = 'annotation',
+  rdc = 'rdc',
 }
 
 export {Control, Setting};

package/src/controls-options-manager/types.ts

@@ -40,13 +40,23 @@ export interface ViewTheParticipantListProperties {
   attendeeCount?: boolean;
 }
 
+export interface AnnotationProperties {
+  enabled?: boolean;
+}
+
+export interface RemoteDesktopControlProperties {
+  enabled?: boolean;
+}
+
 export type Properties =
   | AudioProperties
   | RaiseHandProperties
   | ReactionsProperties
   | ShareControlProperties
   | VideoProperties
-  | ViewTheParticipantListProperties;
+  | ViewTheParticipantListProperties
+  | AnnotationProperties
+  | RemoteDesktopControlProperties;
 
 export interface ControlConfig<Props = Properties> {
   /**

package/src/controls-options-manager/util.ts

@@ -7,6 +7,8 @@ import {
   ReactionsProperties,
   ViewTheParticipantListProperties,
   VideoProperties,
+  type RemoteDesktopControlProperties,
+  type AnnotationProperties,
 } from './types';
 
 /**
@@ -256,6 +258,52 @@ class Utils {
     return Utils.hasHints({requiredHints, displayHints});
   }
 
+  /**
+   * Validate if a annotation-scoped control is allowed to be sent to the service.
+   *
+   * @param {ControlConfig<AnnotationProperties>} control - Annotation control config to validate
+   * @param {Array<string>} displayHints - All available hints
+   * @returns {boolean} - True if all of the actions are allowed.
+   */
+  public static canUpdateAnnotation(
+    control: ControlConfig<AnnotationProperties>,
+    displayHints: Array<string>
+  ): boolean {
+    const requiredHints = [];
+
+    if (control.properties.enabled === true) {
+      requiredHints.push(DISPLAY_HINTS.ENABLE_ANNOTATION_MEETING_OPTION);
+    }
+    if (control.properties.enabled === false) {
+      requiredHints.push(DISPLAY_HINTS.DISABLE_ANNOTATION_MEETING_OPTION);
+    }
+
+    return Utils.hasHints({requiredHints, displayHints});
+  }
+
+  /**
+   * Validate if a rdc-scoped control is allowed to be sent to the service.
+   *
+   * @param {ControlConfig<RemoteDesktopControlProperties>} control - Remote Desktop Control config to validate
+   * @param {Array<string>} displayHints - All available hints
+   * @returns {boolean} - True if all of the actions are allowed.
+   */
+  public static canUpdateRemoteDesktopControl(
+    control: ControlConfig<RemoteDesktopControlProperties>,
+    displayHints: Array<string>
+  ): boolean {
+    const requiredHints = [];
+
+    if (control.properties.enabled === true) {
+      requiredHints.push(DISPLAY_HINTS.ENABLE_RDC_MEETING_OPTION);
+    }
+    if (control.properties.enabled === false) {
+      requiredHints.push(DISPLAY_HINTS.DISABLE_RDC_MEETING_OPTION);
+    }
+
+    return Utils.hasHints({requiredHints, displayHints});
+  }
+
   /**
    * Validate that a control can be sent to the service based on the provided
    * display hints.
@@ -301,6 +349,20 @@ class Utils {
         );
         break;
 
+      case Control.annotation:
+        determinant = Utils.canUpdateAnnotation(
+          control as ControlConfig<AnnotationProperties>,
+          displayHints
+        );
+        break;
+
+      case Control.rdc:
+        determinant = Utils.canUpdateRemoteDesktopControl(
+          control as ControlConfig<RemoteDesktopControlProperties>,
+          displayHints
+        );
+        break;
+
       default:
         determinant = false;
     }

package/src/locus-info/controlsUtils.ts

@@ -1,5 +1,5 @@
 import {isEqual} from 'lodash';
-import {BREAKOUTS} from '../constants';
+import {BREAKOUTS, MEETING_STATE} from '../constants';
 
 const ControlsUtils: any = {};
 
@@ -111,6 +111,18 @@ ControlsUtils.parse = (controls: any) => {
     };
   }
 
+  if (controls?.annotationControl) {
+    parsedControls.annotationControl = {
+      enabled: controls.annotationControl.enabled,
+    };
+  }
+
+  if (controls?.rdcControl) {
+    parsedControls.rdcControl = {
+      enabled: controls.rdcControl.enabled,
+    };
+  }
+
   return parsedControls;
 };
 
@@ -206,11 +218,17 @@ ControlsUtils.getControls = (oldControls: any, newControls: any) => {
         ),
 
       hasPracticeSessionEnabledChanged: !isEqual(
-        previous?.practiceSession?.enabled,
-        current?.practiceSession?.enabled
+        !!previous?.practiceSession?.enabled,
+        !!current?.practiceSession?.enabled
       ),
 
       hasStageViewChanged: !isEqual(previous?.videoLayout, current?.videoLayout),
+
+      hasAnnotationControlChanged:
+        current?.annotationControl?.enabled !== previous?.annotationControl?.enabled,
+
+      hasRemoteDesktopControlChanged:
+        current?.rdcControl?.enabled !== previous?.rdcControl?.enabled,
     },
   };
 };
@@ -242,30 +260,42 @@ ControlsUtils.isNeedReplaceMembers = (oldControls: any, controls: any) => {
   }
 
   return (
-    oldControls.breakout.groupId !== controls.breakout.groupId ||
-    oldControls.breakout.sessionId !== controls.breakout.sessionId
+    oldControls?.breakout?.groupId !== controls?.breakout?.groupId ||
+    oldControls?.breakout?.sessionId !== controls?.breakout?.sessionId
   );
 };
 
 /**
  * determine the switch status between breakout session and main session.
- * @param {LocusControls} oldControls
- * @param {LocusControls} controls
+ * @param {LocusInfo} oldLocus
+ * @param {LocusInfo} newLocus
  * @returns {Object}
  */
-ControlsUtils.getSessionSwitchStatus = (oldControls: any, controls: any) => {
+ControlsUtils.getSessionSwitchStatus = (oldLocus: any, newLocus: any) => {
   const status = {isReturnToMain: false, isJoinToBreakout: false};
   // no breakout case
-  if (!oldControls?.breakout || !controls?.breakout) {
+  if (!oldLocus.controls?.breakout || !newLocus.controls?.breakout) {
     return status;
   }
 
-  status.isReturnToMain =
-    oldControls.breakout.sessionType === BREAKOUTS.SESSION_TYPES.BREAKOUT &&
-    controls.breakout.sessionType === BREAKOUTS.SESSION_TYPES.MAIN;
+  // It is used to fix the timing issue triggered when the creator leaves session to ensure that the member list is complete
+  const needUseCache = !!(
+    oldLocus.self?.isCreator &&
+    newLocus.participants?.length === 1 &&
+    newLocus.participants?.[0].isCreator &&
+    newLocus.participants?.[0].state === MEETING_STATE.STATES.JOINED &&
+    newLocus.controls?.breakout?.sessionType === BREAKOUTS.SESSION_TYPES.MAIN &&
+    newLocus.controls?.breakout?.groups?.length
+  );
+
+  const isReturnToMain =
+    oldLocus.controls.breakout.sessionType === BREAKOUTS.SESSION_TYPES.BREAKOUT &&
+    newLocus.controls.breakout.sessionType === BREAKOUTS.SESSION_TYPES.MAIN;
+
+  status.isReturnToMain = needUseCache || isReturnToMain;
   status.isJoinToBreakout =
-    oldControls.breakout.sessionType === BREAKOUTS.SESSION_TYPES.MAIN &&
-    controls.breakout.sessionType === BREAKOUTS.SESSION_TYPES.BREAKOUT;
+    oldLocus.controls.breakout.sessionType === BREAKOUTS.SESSION_TYPES.MAIN &&
+    newLocus.controls.breakout.sessionType === BREAKOUTS.SESSION_TYPES.BREAKOUT;
 
   return status;
 };

package/src/locus-info/index.ts

@@ -17,7 +17,9 @@ import {
   MEETING_REMOVED_REASON,
   CALL_REMOVED_REASON,
   RECORDING_STATE,
+  BREAKOUTS,
 } from '../constants';
+
 import InfoUtils from './infoUtils';
 import FullState from './fullState';
 import SelfUtils from './selfUtils';
@@ -67,6 +69,7 @@ export default class LocusInfo extends EventsScope {
   services: any;
   resources: any;
   mainSessionLocusCache: any;
+  self: any;
   /**
    * Constructor
    * @param {function} updateMeeting callback to update the meeting object from an object
@@ -814,6 +817,8 @@ export default class LocusInfo extends EventsScope {
           hasMeetingFullChanged,
           hasPracticeSessionEnabledChanged,
           hasStageViewChanged,
+          hasAnnotationControlChanged,
+          hasRemoteDesktopControlChanged,
         },
         current,
       } = ControlsUtils.getControls(this.controls, controls);
@@ -1049,6 +1054,22 @@ export default class LocusInfo extends EventsScope {
         );
       }
 
+      if (hasAnnotationControlChanged) {
+        this.emitScoped(
+          {file: 'locus-info', function: 'updateControls'},
+          LOCUSINFO.EVENTS.CONTROLS_ANNOTATION_CHANGED,
+          {state: current.annotationControl}
+        );
+      }
+
+      if (hasRemoteDesktopControlChanged) {
+        this.emitScoped(
+          {file: 'locus-info', function: 'updateControls'},
+          LOCUSINFO.EVENTS.CONTROLS_REMOTE_DESKTOP_CONTROL_CHANGED,
+          {state: current.rdcControl}
+        );
+      }
+
       this.controls = controls;
     }
   }
@@ -1706,7 +1727,8 @@ export default class LocusInfo extends EventsScope {
    * @memberof LocusInfo
    */
   getTheLocusToUpdate(newLocus: any) {
-    const switchStatus = ControlsUtils.getSessionSwitchStatus(this.controls, newLocus?.controls);
+    const switchStatus = ControlsUtils.getSessionSwitchStatus(this, newLocus);
+
     if (switchStatus.isReturnToMain && this.mainSessionLocusCache) {
       return cloneDeep(this.mainSessionLocusCache);
     }