@webex/plugin-meetings 2.35.3 → 2.36.0

package/src/locus-info/{selfUtils.js → selfUtils.ts}

@@ -1,4 +1,3 @@
-
 import {
   _IDLE_,
   _JOINED_,
@@ -15,7 +14,7 @@ import {
 } from '../constants';
 import ParameterError from '../common/errors/parameter';
 
-const SelfUtils = {};
+const SelfUtils: any = {};
 const PSTN_DEVICE_TYPE = 'PROVISIONAL';
 
 /**
@@ -24,7 +23,7 @@ const PSTN_DEVICE_TYPE = 'PROVISIONAL';
  * @param {String} deviceId
  * @returns {undefined}
  */
-SelfUtils.parse = (self, deviceId) => {
+SelfUtils.parse = (self: any, deviceId: string) => {
   if (self) {
     const joinedWith = self.devices.find((device) => deviceId === device.url);
     const pstnDevices = self.devices.filter((device) => PSTN_DEVICE_TYPE === device.deviceType);
@@ -84,7 +83,7 @@ SelfUtils.isSharingBlocked = (self) => !!self?.isSharingBlocked;
 SelfUtils.getSelves = (oldSelf, newSelf, deviceId) => {
   const previous = oldSelf && SelfUtils.parse(oldSelf, deviceId);
   const current = newSelf && SelfUtils.parse(newSelf, deviceId);
-  const updates = {};
+  const updates: any = {};
 
   updates.isUserUnadmitted = SelfUtils.isUserUnadmitted(current);
   updates.isUserAdmitted = SelfUtils.isUserAdmitted(previous, current);
@@ -116,7 +115,7 @@ SelfUtils.getSelves = (oldSelf, newSelf, deviceId) => {
  * @param {Object} self
  * @returns {boolean} isJoined
 */
-SelfUtils.isJoined = (self) => self?.state === _JOINED_;
+SelfUtils.isJoined = (self: any) => self?.state === _JOINED_;
 
 /**
  * Validate if the Meeting Layout Controls Layout has changed.
@@ -125,8 +124,7 @@ SelfUtils.isJoined = (self) => self?.state === _JOINED_;
  * @param {Self} current - Current self state [per event]
  * @returns {boolean} - If the MEeting Layout Controls Layout has changed.
  */
-SelfUtils.layoutChanged = (previous, current) => current?.layout && previous?.layout !== current?.layout;
-
+SelfUtils.layoutChanged = (previous: any, current: any) => current?.layout && previous?.layout !== current?.layout;
 
 SelfUtils.isMediaInactive = (previous, current) => {
   if (
@@ -198,7 +196,7 @@ SelfUtils.getModifiedBy = (self) => {
  * @param {Object} self
  * @returns {String}
  */
-SelfUtils.getSelfIdentity = (self) => {
+SelfUtils.getSelfIdentity = (self: any) => {
   if (!self && !self.person) {
     return null;
   }
@@ -211,7 +209,7 @@ SelfUtils.getSelfIdentity = (self) => {
  * @param {Object} self
  * @returns {Boolean}
  */
-SelfUtils.getRemoteMuted = (self) => {
+SelfUtils.getRemoteMuted = (self: any) => {
   if (!self || !self.controls || !self.controls.audio) {
     return null;
   }
@@ -244,28 +242,28 @@ SelfUtils.getStatus = (status) => ({
  * @param {Object} changedSelf
  * @returns {Boolean}
  */
-SelfUtils.wasMediaInactiveOrReleased = (oldSelf = {}, changedSelf) => oldSelf.joinedWith && oldSelf.joinedWith.state === _JOINED_ && changedSelf.joinedWith.state === _LEFT_ &&
- (changedSelf.joinedWith.reason === MEETING_END_REASON.INACTIVE || changedSelf.joinedWith.reason === MEETING_END_REASON.MEDIA_RELEASED);
+SelfUtils.wasMediaInactiveOrReleased = (oldSelf: any = {}, changedSelf: any) => oldSelf.joinedWith && oldSelf.joinedWith.state === _JOINED_ && changedSelf.joinedWith.state === _LEFT_ &&
+(changedSelf.joinedWith.reason === MEETING_END_REASON.INACTIVE || changedSelf.joinedWith.reason === MEETING_END_REASON.MEDIA_RELEASED);
 
 
 /**
  * @param {Object} check
  * @returns {Boolean}
  */
-SelfUtils.isLocusUserUnadmitted = (check) => check && check.joinedWith?.intent?.type === _WAIT_ && check.state === _IDLE_;
+SelfUtils.isLocusUserUnadmitted = (check: any) => check && check.joinedWith?.intent?.type === _WAIT_ && check.state === _IDLE_;
 
 /**
  * @param {Object} check
  * @returns {Boolean}
  */
-SelfUtils.isLocusUserAdmitted = (check) => check && check.joinedWith?.intent?.type !== _WAIT_ && check.state === _JOINED_;
+SelfUtils.isLocusUserAdmitted = (check: any) => check && check.joinedWith?.intent?.type !== _WAIT_ && check.state === _JOINED_;
 
 /**
  * @param {Object} self
  * @returns {Boolean}
  * @throws {Error} when self is undefined
  */
-SelfUtils.isUserUnadmitted = (self) => {
+SelfUtils.isUserUnadmitted = (self: object) => {
   if (!self) {
     throw new ParameterError('self must be defined to determine if self is unadmitted as guest.');
   }
@@ -291,7 +289,7 @@ SelfUtils.moderatorChanged = (oldSelf, changedSelf) => {
  * @returns {Boolean}
  * @throws {Error} if changed self was undefined
  */
-SelfUtils.isDeviceObserving = (oldSelf, changedSelf) => oldSelf && oldSelf.joinedWith?.intent?.type === _MOVE_MEDIA_ && changedSelf && changedSelf.joinedWith?.intent?.type === _OBSERVE_;
+SelfUtils.isDeviceObserving = (oldSelf: any, changedSelf: any) => oldSelf && oldSelf.joinedWith?.intent?.type === _MOVE_MEDIA_ && changedSelf && changedSelf.joinedWith?.intent?.type === _OBSERVE_;
 
 /**
  * @param {Object} oldSelf
@@ -299,7 +297,7 @@ SelfUtils.isDeviceObserving = (oldSelf, changedSelf) => oldSelf && oldSelf.joine
  * @returns {Boolean}
  * @throws {Error} if changed self was undefined
  */
-SelfUtils.isUserAdmitted = (oldSelf, changedSelf) => {
+SelfUtils.isUserAdmitted = (oldSelf: object, changedSelf: object) => {
   if (!oldSelf) {
     // if there was no previous locus, it couldn't have been admitted yet
     return false;
@@ -329,7 +327,7 @@ SelfUtils.mutedByOthersChanged = (oldSelf, changedSelf) => {
     ((oldSelf.remoteMuted !== changedSelf.remoteMuted) || (changedSelf.remoteMuted && (oldSelf.unmuteAllowed !== changedSelf.unmuteAllowed)));
 };
 
-SelfUtils.localAudioUnmuteRequestedByServer = (oldSelf = {}, changedSelf) => {
+SelfUtils.localAudioUnmuteRequestedByServer = (oldSelf: any = {}, changedSelf: any) => {
   if (!changedSelf) {
     throw new ParameterError('New self must be defined to determine if self received request to unmute.');
   }
@@ -338,7 +336,7 @@ SelfUtils.localAudioUnmuteRequestedByServer = (oldSelf = {}, changedSelf) => {
 };
 
 
-SelfUtils.localAudioUnmuteRequiredByServer = (oldSelf = {}, changedSelf) => {
+SelfUtils.localAudioUnmuteRequiredByServer = (oldSelf: any = {}, changedSelf: any) => {
   if (!changedSelf) {
     throw new ParameterError('New self must be defined to determine if localAudioUnmuteRequired changed.');
   }
@@ -353,7 +351,7 @@ SelfUtils.localAudioUnmuteRequiredByServer = (oldSelf = {}, changedSelf) => {
  * @returns {Object}
  */
 
-SelfUtils.getSipUrl = (partner, type, sipUri) => {
+SelfUtils.getSipUrl = (partner: any, type, sipUri) => {
   // For webex meeting the sipUrl gets updated in info parser
   if (partner && type === _CALL_) {
     return {sipUri: partner.person.sipUrl || partner.person.id};

package/src/media/{index.js → index.ts}

@@ -46,7 +46,7 @@ const {isBrowser} = BrowserDetection();
  * Handles the quirks of each browser.
  * Extends and enhances adapter.js, i.e., the "media" file from the web client.
  */
-const Media = {};
+const Media: any = {};
 
 /**
  * @param {boolean} enabled
@@ -54,7 +54,7 @@ const Media = {};
  * @returns {Boolean}
  * @public
  */
-Media.setLocalTrack = (enabled, track) => {
+Media.setLocalTrack = (enabled: boolean, track: MediaStreamTrack) => {
   if (track) {
     track.enabled = enabled;
 
@@ -71,12 +71,20 @@ Media.setLocalTrack = (enabled, track) => {
  * @param {string} meetingProperties.remoteQualityLevel LOW|MEDIUM|HIGH
  * @returns {Promise}
  */
-Media.reconnectMedia = (peerConnection, {
-  meetingId,
-  remoteQualityLevel,
-  enableRtx,
-  enableExtmap
-}) => {
+Media.reconnectMedia = (
+  peerConnection: RTCPeerConnection,
+  {
+    meetingId,
+    remoteQualityLevel,
+    enableRtx,
+    enableExtmap,
+  }: {
+    meetingId: string;
+    remoteQualityLevel: string;
+    enableRtx: any;
+    enableExtmap: any
+  }
+) => {
   if (peerConnection.connectionState === PEER_CONNECTION_STATE.CLOSED ||
     peerConnection.connectionState === PEER_CONNECTION_STATE.FAILED) {
     return Promise.reject(new ReconnectionError('Reinitiate peerconnection'));
@@ -97,7 +105,7 @@ Media.reconnectMedia = (peerConnection, {
  * @param {Boolean} videoMuted
  * @returns {Array} medias
  */
-Media.generateLocalMedias = (mediaId, audioMuted, videoMuted) => {
+Media.generateLocalMedias = (mediaId: string, audioMuted: boolean, videoMuted: boolean) => {
   if (mediaId) {
     return [
       {
@@ -119,7 +127,7 @@ Media.generateLocalMedias = (mediaId, audioMuted, videoMuted) => {
  * @param {Object} config SDK Configuration for meetings plugin
  * @returns {Promise}
  */
-Media.getLocalMedia = (options, config) => {
+Media.getLocalMedia = (options: any, config: object) => {
   const {
     sendAudio, sendVideo, sendShare, sharePreferences, isSharing
   } = options;
@@ -148,7 +156,7 @@ Media.getLocalMedia = (options, config) => {
  * @param {boolean} receiveTracks do you want to receive tracks from the remote side
  * @returns {Object} returns direction tracks to be added in transceiver
  */
-Media.checkTracks = (trackType, track, receiveTracks) => {
+Media.checkTracks = (trackType: string, track: object, receiveTracks: boolean) => {
   const getDirection = (sendTracks, receiveTracks) => {
     if (sendTracks && receiveTracks) {
       return 'sendrecv';
@@ -175,12 +183,20 @@ Media.checkTracks = (trackType, track, receiveTracks) => {
  * @param {string} meetingProperties.remoteQualityLevel LOW|MEDIUM|HIGH
  * @returns {Array} [peerConnection, ]
  */
-Media.attachMedia = (mediaProperties, {
-  meetingId,
-  remoteQualityLevel,
-  enableRtx,
-  enableExtmap
-}) => {
+Media.attachMedia = (
+  mediaProperties: any,
+  {
+    meetingId,
+    remoteQualityLevel,
+    enableRtx,
+    enableExtmap,
+  }: {
+    meetingId: string;
+    remoteQualityLevel: string;
+    enableRtx: any;
+    enableExtmap: any;
+  }
+) => {
   const {
     mediaDirection,
     audioTrack,
@@ -223,12 +239,20 @@ Media.attachMedia = (mediaProperties, {
  * @param {string} meetingProperties.remoteQualityLevel LOW|MEDIUM|HIGH
  * @returns {Promise}
  */
-Media.updateMedia = (mediaProperties, {
-  meetingId,
-  remoteQualityLevel,
-  enableRtx,
-  enableExtmap
-}) => {
+Media.updateMedia = (
+  mediaProperties: any,
+  {
+    meetingId,
+    remoteQualityLevel,
+    enableRtx,
+    enableExtmap,
+  }: {
+    meetingId: string;
+    remoteQualityLevel: string;
+    enableRtx: any;
+    enableExtmap: any;
+  }
+) => {
   const {
     mediaDirection,
     audioTrack,
@@ -278,7 +302,15 @@ Media.updateMedia = (mediaProperties, {
  * @param {MediaStreamTrack} options.track
  * @returns {undefined}
  */
-Media.setTrackOnTransceiver = (transceiver, options) => {
+Media.setTrackOnTransceiver = (
+  transceiver: RTCRtpTransceiver,
+  options: {
+    track: MediaStreamTrack;
+    type: any;
+    sendTrack: any;
+    receiveTrack: any;
+  }
+) => {
   const {
     type, track, sendTrack, receiveTrack
   } = options;
@@ -307,12 +339,22 @@ Media.setTrackOnTransceiver = (transceiver, options) => {
  * @param {Object} options see #Media.setTrackOnTransceiver
  * @returns {Promise}
  */
-Media.updateTransceiver = ({
-  meetingId,
-  remoteQualityLevel,
-  enableRtx,
-  enableExtmap
-}, peerConnection, transceiver, options) => {
+Media.updateTransceiver = (
+  {
+    meetingId,
+    remoteQualityLevel,
+    enableRtx,
+    enableExtmap,
+  }: {
+    meetingId: string;
+    remoteQualityLevel: string;
+    enableRtx: any;
+    enableExtmap: any;
+  },
+  peerConnection: RTCPeerConnection,
+  transceiver: RTCRtpTransceiver,
+  options: object
+) => {
   Media.setTrackOnTransceiver(transceiver, options);
 
   return PeerConnectionManager.createOffer(peerConnection, {
@@ -335,7 +377,17 @@ Media.updateTransceiver = ({
  * @param {Object} config SDK Configuration for meetings plugin
  * @returns {Promise.<MediaStream>}
  */
-Media.getDisplayMedia = (options, config = {}) => {
+Media.getDisplayMedia = (
+  options: {
+    sendAudio: boolean;
+    sendShare: boolean;
+    sharePreferences: {
+      shareConstraints: MediaTrackConstraints;
+      highFrameRate: any;
+    };
+  },
+  config: any = {}
+) => {
   // SDK screen share resolution settings from Webex.init
   const customResolution = config.screenResolution || {};
   // user defined screen share frame rate
@@ -352,7 +404,7 @@ Media.getDisplayMedia = (options, config = {}) => {
     aspectRatio
   } = Config.meetings;
 
-  let shareConstraints = {
+  let shareConstraints: any = {
     cursor: MEDIA_TRACK_CONSTRAINT.CURSOR.AWLAYS,
     aspectRatio
   };
@@ -388,7 +440,7 @@ Media.getDisplayMedia = (options, config = {}) => {
 
 
   if (isBrowser('firefox')) {
-    const mediaConfig = {
+    const mediaConfig: any = {
       audio: options.sendAudio,
       video: options.sendShare
     };
@@ -408,7 +460,7 @@ Media.getDisplayMedia = (options, config = {}) => {
       });
   }
 
-  const getDisplayMediaParams = {video: options.sendShare ? shareConstraints : false};
+  const getDisplayMediaParams: any = {video: options.sendShare ? shareConstraints : false};
 
   // safari doesn't support sending screen share audio
   // https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getDisplayMedia
@@ -426,7 +478,7 @@ Media.getDisplayMedia = (options, config = {}) => {
  * @param {Object} config SDK Configuration for meetings plugin
  * @returns {Object} {streams}
  */
-Media.getMedia = (audio, video, config) => {
+Media.getMedia = (audio: any | boolean, video: any | boolean, config: any) => {
   const defaultWidth = {ideal: config.resolution.idealWidth, max: config.resolution.maxWidth};
   const defaultHeight = {ideal: config.resolution.idealHeight, max: config.resolution.maxHeight};
   const mediaConfig = {
@@ -471,7 +523,7 @@ Media.getMedia = (audio, video, config) => {
  *    sendVideo: true/false
  *}
  */
-Media.getSupportedDevice = ({sendAudio, sendVideo}) =>
+Media.getSupportedDevice = ({ sendAudio, sendVideo }: { sendAudio: boolean; sendVideo: boolean }) =>
   Promise.resolve().then(() => {
     if (!navigator.mediaDevices || navigator.mediaDevices.enumerateDevices === undefined) {
       return {
@@ -518,7 +570,7 @@ Media.toggleStream = () => {};
  * @param {MediaTrack} track A media stream
  * @returns {null}
  */
-Media.stopTracks = (track) => {
+Media.stopTracks = (track: any) => {
   if (!track) {
     return Promise.resolve();
   }
@@ -542,7 +594,7 @@ Media.stopTracks = (track) => {
  * @returns {null}
  * @deprecated after v1.89.3
  */
-Media.stopStream = (stream) => {
+Media.stopStream = (stream: any) => {
   LoggerProxy.logger.warn('Media:index#stopStream --> [DEPRECATION WARNING]: stopStream has been deprecated after v1.89.3');
   if (!stream) {
     return Promise.resolve();
@@ -581,7 +633,24 @@ Media.stopStream = (stream) => {
  * @param {Object} config SDK Config
  * @returns {Array} [localStream, shareStream]
  */
-Media.getUserMedia = (mediaSetting, audioVideo, sharePreferences, config) => Media.getLocalMedia({
+Media.getUserMedia = (
+  mediaSetting: {
+    sendAudio: object;
+    sendVideo: object;
+    sendShare: object;
+    isSharing: object;
+  },
+  audioVideo: {
+    audio: object;
+    video: object;
+  },
+  sharePreferences: {
+    shareConstraints: object;
+    highFrameRate: boolean;
+  },
+  config: object
+) =>
+Media.getLocalMedia({
   sendAudio: mediaSetting.sendAudio ? audioVideo.audio || mediaSetting.sendAudio : false,
   sendVideo: mediaSetting.sendVideo ? audioVideo.video || mediaSetting.sendVideo : false
 }, config).then((localStream) => Media.getLocalMedia({

package/src/media/{properties.js → properties.ts}

@@ -12,13 +12,25 @@ import MediaUtil from './util';
  * @class MediaProperties
  */
 export default class MediaProperties {
+  audioTrack: any;
+  localQualityLevel: any;
+  mediaDirection: any;
+  mediaSettings: any;
+  peerConnection: any;
+  remoteAudioTrack: any;
+  remoteQualityLevel: any;
+  remoteShare: any;
+  remoteVideoTrack: any;
+  shareTrack: any;
+  videoDeviceId: any;
+  videoTrack: any;
   namespace = MEETINGS;
 
   /**
    * @param {Object} [options] -- to auto construct
    * @returns {MediaProperties}
    */
-  constructor(options = {}) {
+  constructor(options: any = {}) {
     this.peerConnection = MediaUtil.createPeerConnection();
     this.mediaDirection = options.mediaDirection;
     this.videoTrack = options.videoTrack;
@@ -82,7 +94,7 @@ export default class MediaProperties {
    * @param {MediaTrack} remoteAudioTrack MediaTrack to save
    * @returns {void}
    */
-  setRemoteAudioTrack(remoteAudioTrack) {
+  setRemoteAudioTrack(remoteAudioTrack: any) {
     this.remoteAudioTrack = remoteAudioTrack;
   }
 
@@ -91,7 +103,7 @@ export default class MediaProperties {
    * @param {MediaTrack} remoteVideoTrack MediaTrack to save
    * @returns {void}
    */
-  setRemoteVideoTrack(remoteVideoTrack) {
+  setRemoteVideoTrack(remoteVideoTrack: any) {
     this.remoteVideoTrack = remoteVideoTrack;
   }
 
@@ -100,7 +112,7 @@ export default class MediaProperties {
    * @param {string} deviceId Preferred video input device
    * @returns {void}
    */
-  setVideoDeviceId(deviceId) {
+  setVideoDeviceId(deviceId: string) {
     this.videoDeviceId = deviceId;
   }
 

package/src/media/{util.js → util.ts}

@@ -6,10 +6,10 @@ import LoggerProxy from '../common/logs/logger-proxy';
 
 const {isBrowser} = BrowserDetection();
 
-const MediaUtil = {};
+const MediaUtil: any = {};
 
 MediaUtil.createPeerConnection = (turnServerInfo) => {
-  const config = {iceServers: []};
+  const config: any = {iceServers: []};
 
   if (turnServerInfo) {
     config.iceServers.push({
@@ -25,7 +25,6 @@ MediaUtil.createPeerConnection = (turnServerInfo) => {
   return new window.RTCPeerConnection(config);
 };
 
-
 MediaUtil.createMediaStream = (tracks) => {
   if (!tracks) {
     LoggerProxy.logger.error('Media:util#createMediaStream --> Tracks don\'t exist');

package/src/mediaQualityMetrics/{config.js → config.ts}

@@ -1,4 +1,3 @@
-
 export default {
   intervals: [
     {
@@ -380,3 +379,4 @@ export default {
     }
   ]
 };
+

package/src/meeting/{effectsState.js → effectsState.ts}

@@ -7,7 +7,7 @@ import MediaUtil from '../media/util';
 import LoggerProxy from '../common/logs/logger-proxy';
 import {BNR_STATUS} from '../constants';
 
-const createEffectsState = (type) => {
+const createEffectsState = (type: any) => {
   LoggerProxy.logger.info(`Meeting:effectState#createEffectsState --> creating effectsState for effect ${type}`);
 
   return new EffectsState(type);
@@ -16,7 +16,12 @@ const createEffectsState = (type) => {
 /* The purpose of this class is to manage the effects state(for eg., BNR).
 */
 class EffectsState {
-  constructor(type) {
+  effectType: any;
+  pendingPromiseReject: any;
+  pendingPromiseResolve: any;
+  state: any;
+
+  constructor(type: any) {
     this.effectType = type;
     this.state = {
       bnr: {
@@ -35,7 +40,7 @@ class EffectsState {
    * @param {Object} [meeting] the meeting object
    * @returns {Promise}
    */
-  async handleClientRequest(isEnable, meeting) {
+  async handleClientRequest(isEnable?: boolean, meeting?: object) {
     return new Promise((resolve, reject) => {
       if (this.pendingPromiseResolve) {
         // resolve the last promise we returned to the client as the client has issued a new request that has superseded the previous one
@@ -56,7 +61,7 @@ class EffectsState {
    * @public
    * @memberof Meeting
    */
-  isBnrEnabled() {
+  public isBnrEnabled() {
     return this.state.bnr.enabled === BNR_STATUS.ENABLED;
   }
 
@@ -83,7 +88,7 @@ class EffectsState {
    * @public
    * @memberof EffectsState
    */
-  async enableBNR(meeting) {
+  public async enableBNR(meeting: any) {
     LoggerProxy.logger.info('Meeting:effectState#enableBNR. Enable BNR called');
 
     if (this.isBnrEnabled()) {
@@ -146,7 +151,7 @@ class EffectsState {
    * @public
    * @memberof EffectsState
    */
-  async disableBNR(meeting) {
+  public async disableBNR(meeting: any) {
     LoggerProxy.logger.info('Meeting:effectState#disableBNR. Disable BNR called');
 
     const {bnr} = this.state;
@@ -161,6 +166,7 @@ class EffectsState {
       bnr.enabled = BNR_STATUS.SHOULD_DISABLE;
       this.state.callToWebrtcBNRInProgress = true;
 
+      // @ts-ignore - disableBNR does not expect an argument
       const audioTrack = WebRTCMedia.Effects.BNR.disableBNR(meeting.mediaProperties.audioTrack);
 
       const audioStream = MediaUtil.createMediaStream([audioTrack]);