@webex/plugin-meetings 3.0.0-beta.1 → 3.0.0-beta.11

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

@@ -1,4 +1,3 @@
-
 import LoggerProxy from '../common/logs/logger-proxy';
 import ParameterError from '../common/errors/parameter';
 import PermissionError from '../common/errors/permission';
@@ -11,6 +10,7 @@ import {AUDIO, VIDEO} from '../constants';
    If we ever need to support it, search for REMOTE_MUTE_VIDEO_MISSING_IMPLEMENTATION string to find the places that need updating
 */
 
+
 const createMuteState = (type, meeting, mediaDirection) => {
   if (type === AUDIO && !mediaDirection.sendAudio) {
     return null;
@@ -30,13 +30,18 @@ const createMuteState = (type, meeting, mediaDirection) => {
    More info about Locus muting API: https://sqbu-github.cisco.com/pages/WebExSquared/locus/guides/mute.html#
 */
 class MuteState {
+  pendingPromiseReject: any;
+  pendingPromiseResolve: any;
+  state: any;
+  type: any;
+
   /**
    * Constructor
    *
    * @param {String} type - audio or video
    * @param {Object} meeting - the meeting object (used for reading current remote mute status)
    */
-  constructor(type, meeting) {
+  constructor(type: string, meeting: any) {
     if ((type !== AUDIO) && (type !== VIDEO)) {
       throw new ParameterError('Mute state is designed for handling audio or video only');
     }
@@ -72,7 +77,7 @@ class MuteState {
    * @param {Boolean} [mute] true for muting, false for unmuting request
    * @returns {Promise}
    */
-  handleClientRequest(meeting, mute) {
+  public handleClientRequest(meeting?: object, mute?: boolean) {
     LoggerProxy.logger.info(`Meeting:muteState#handleClientRequest --> ${this.type}: user requesting new mute state: ${mute}`);
 
     if (!mute && !this.state.server.unmuteAllowed) {
@@ -103,7 +108,7 @@ class MuteState {
    * @memberof MuteState
    * @returns {void}
    */
-  applyClientStateLocally(meeting) {
+  public applyClientStateLocally(meeting?: any) {
     Media.setLocalTrack(
       !this.state.client.localMute,
       (this.type === AUDIO) ? meeting.mediaProperties.audioTrack : meeting.mediaProperties.videoTrack
@@ -118,7 +123,7 @@ class MuteState {
    * @memberof MuteState
    * @returns {void}
    */
-  applyClientStateToServer(meeting) {
+  private applyClientStateToServer(meeting?: object) {
     if (this.state.syncToServerInProgress) {
       LoggerProxy.logger.info(`Meeting:muteState#applyClientStateToServer --> ${this.type}: request to server in progress, we need to wait for it to complete`);
 
@@ -178,7 +183,7 @@ class MuteState {
    * @memberof MuteState
    * @returns {Promise}
    */
-  sendLocalMuteRequestToServer(meeting) {
+  private sendLocalMuteRequestToServer(meeting?: any) {
     const audioMuted = (this.type === AUDIO) ? this.state.client.localMute : meeting.audio?.state.client.localMute;
     const videoMuted = (this.type === VIDEO) ? this.state.client.localMute : meeting.video?.state.client.localMute;
 
@@ -214,7 +219,7 @@ class MuteState {
    * @memberof MuteState
    * @returns {Promise}
    */
-  sendRemoteMuteRequestToServer(meeting) {
+  private sendRemoteMuteRequestToServer(meeting?: any) {
     if (this.type === AUDIO) {
       const remoteMute = this.state.client.localMute;
 
@@ -252,7 +257,7 @@ class MuteState {
    * @param {Boolean} [unmuteAllowed] indicates if user is allowed to unmute self (false when "hard mute" feature is used)
    * @returns {undefined}
    */
-  handleServerRemoteMuteUpdate(muted, unmuteAllowed) {
+  public handleServerRemoteMuteUpdate(muted?: boolean, unmuteAllowed?: boolean) {
     LoggerProxy.logger.info(`Meeting:muteState#handleServerRemoteMuteUpdate --> ${this.type}: updating server remoteMute to (${muted})`);
     this.state.server.remoteMute = muted;
     this.state.server.unmuteAllowed = unmuteAllowed;
@@ -266,7 +271,7 @@ class MuteState {
    * @param {Object} [meeting] the meeting object
    * @returns {undefined}
    */
-  handleServerLocalUnmuteRequired(meeting) {
+  public handleServerLocalUnmuteRequired(meeting?: object) {
     LoggerProxy.logger.info(`Meeting:muteState#handleServerLocalUnmuteRequired --> ${this.type}: localAudioUnmuteRequired received -> doing local unmute`);
 
     this.state.server.remoteMute = false;
@@ -289,7 +294,7 @@ class MuteState {
    * @memberof MuteState
    * @returns {Boolean}
    */
-  isMuted() {
+  public isMuted() {
     return this.state.client.localMute || this.state.server.localMute || this.state.server.remoteMute;
   }
 
@@ -300,7 +305,7 @@ class MuteState {
    * @memberof MuteState
    * @returns {Boolean}
    */
-  isSelf() {
+  public isSelf() {
     return this.state.client.localMute && !this.state.server.remoteMute;
   }
 

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

@@ -1,6 +1,8 @@
 import uuid from 'uuid';
 import {debounce} from 'lodash';
+// @ts-ignore
 import {StatelessWebexPlugin} from '@webex/webex-core';
+// @ts-ignore
 import {deviceType} from '@webex/common';
 
 import LoggerProxy from '../common/logs/logger-proxy';
@@ -23,12 +25,15 @@ import {
   SEND_DTMF_ENDPOINT,
   _SLIDES_
 } from '../constants';
+import {Reaction} from '../reactions/reactions.type';
 
 /**
  * @class MeetingRequest
  */
 export default class MeetingRequest extends StatelessWebexPlugin {
-  constructor(attrs, options) {
+  changeVideoLayoutDebounced: any;
+
+  constructor(attrs: any, options: any) {
     super(attrs, options);
     this.changeVideoLayoutDebounced = debounce(this.changeVideoLayout, 2000, {leading: true, trailing: true});
   }
@@ -48,7 +53,23 @@ export default class MeetingRequest extends StatelessWebexPlugin {
    * @param {Object} options.roapMessage
    * @returns {Promise}
    */
-  async joinMeeting(options) {
+  async joinMeeting(options: {
+    sipUri: string;
+    deviceUrl: string;
+    locusUrl: string;
+    resourceId: string;
+    correlationId: string;
+    ensureConversation: boolean;
+    moderator: boolean;
+    pin: boolean;
+    moveToResource: boolean;
+    roapMessage: any;
+    asResourceOccupant: any;
+    inviteeAddress: any;
+    meetingNumber: any;
+    permissionToken: any;
+    preferTranscoding: any;
+  }) {
     const {
       asResourceOccupant,
       inviteeAddress,
@@ -73,10 +94,11 @@ export default class MeetingRequest extends StatelessWebexPlugin {
 
     let url = '';
 
-    const body = {
+    const body: any = {
       asResourceOccupant,
       device: {
         url: deviceUrl,
+        // @ts-ignore - config comes from registerPlugin
         deviceType: this.config.meetings.deviceType
       },
       usingResource: resourceId || null,
@@ -91,8 +113,11 @@ export default class MeetingRequest extends StatelessWebexPlugin {
       }
     };
 
+    // @ts-ignore
     if (this.webex.meetings.clientRegion) {
+      // @ts-ignore
       body.device.countryCode = this.webex.meetings.clientRegion.countryCode;
+      // @ts-ignore
       body.device.regionCode = this.webex.meetings.clientRegion.regionCode;
     }
 
@@ -113,7 +138,9 @@ export default class MeetingRequest extends StatelessWebexPlugin {
     }
     else if (inviteeAddress || meetingNumber) {
       try {
+        // @ts-ignore
         await this.webex.internal.services.waitForCatalog('postauth');
+        // @ts-ignore
         url = `${this.webex.internal.services.get('locus')}/${LOCI}/${CALL}`;
         body.invitee = {
           address: inviteeAddress || `wbxmn:${meetingNumber}`
@@ -139,6 +166,7 @@ export default class MeetingRequest extends StatelessWebexPlugin {
       body.localMedias = roapMessage.localMedias;
     }
 
+    /// @ts-ignore
     return this.request({
       method: HTTP_VERBS.POST,
       uri: url,
@@ -154,14 +182,12 @@ export default class MeetingRequest extends StatelessWebexPlugin {
    * @returns {Promise}
    * @private
    */
-  refreshCaptcha({
-    captchaRefreshUrl,
-    captchaId
-  }) {
+  private refreshCaptcha({ captchaRefreshUrl, captchaId }: { captchaRefreshUrl: string; captchaId: string }) {
     const body = {
       captchaId
     };
 
+    // @ts-ignore
     return this.request({
       method: HTTP_VERBS.POST,
       uri: captchaRefreshUrl,
@@ -177,17 +203,22 @@ export default class MeetingRequest extends StatelessWebexPlugin {
    * Make a network request to add a dial in device
    * @param {Object} options
    * @param {String} options.correlationId
-   * @param {String} options.localUrl url for the meeting
+   * @param {String} options.locusUrl url for the meeting
    * @param {String} options.dialInUrl identifier for the to-be provisioned device
    * @param {String} options.clientUrl identifier for the web device
    * @returns {Promise}
    * @private
    */
-  dialIn({
+  private dialIn({
     locusUrl,
     dialInUrl,
     clientUrl,
-    correlationId
+    correlationId,
+  }: {
+    correlationId: string;
+    locusUrl: string;
+    dialInUrl: string;
+    clientUrl: string;
   }) {
     LoggerProxy.logger.info(
       'Meeting:request#dialIn --> Provisioning a dial in device',
@@ -205,6 +236,7 @@ export default class MeetingRequest extends StatelessWebexPlugin {
       correlationId
     };
 
+    // @ts-ignore
     return this.request({
       method: HTTP_VERBS.POST,
       uri,
@@ -220,19 +252,25 @@ export default class MeetingRequest extends StatelessWebexPlugin {
    * Make a network request to add a dial out device
    * @param {Object} options
    * @param {String} options.correlationId
-   * @param {String} options.localUrl url for the meeting
+   * @param {String} options.locusUrl url for the meeting
    * @param {String} options.dialOutUrl identifier for the to-be provisioned device
    * @param {String} options.phoneNumber phone number to dial out to
    * @param {String} options.clientUrl identifier for the web device
    * @returns {Promise}
    * @private
    */
-  dialOut({
+  private dialOut({
     locusUrl,
     dialOutUrl,
     phoneNumber,
     clientUrl,
-    correlationId
+    correlationId,
+  }: {
+    correlationId: string;
+    locusUrl: string;
+    dialOutUrl: string;
+    phoneNumber: string;
+    clientUrl: string;
   }) {
     LoggerProxy.logger.info(
       'Meeting:request#dialOut --> Provisioning a dial out device',
@@ -251,6 +289,7 @@ export default class MeetingRequest extends StatelessWebexPlugin {
       correlationId
     };
 
+    // @ts-ignore
     return this.request({
       method: HTTP_VERBS.POST,
       uri,
@@ -265,11 +304,11 @@ export default class MeetingRequest extends StatelessWebexPlugin {
   /**
    * Syns the missed delta event
    * @param {Object} options
-   * @param {boolen} options.desync flag to get partial or whole locus object
+   * @param {boolean} options.desync flag to get partial or whole locus object
    * @param {String} options.syncUrl sync url to get ht elatest locus delta
    * @returns {Promise}
    */
-  syncMeeting(options) {
+  syncMeeting(options: { desync: boolean; syncUrl: string }) {
     /* eslint-disable no-else-return */
     const {desync} = options;
     let {syncUrl} = options;
@@ -280,6 +319,7 @@ export default class MeetingRequest extends StatelessWebexPlugin {
       syncUrl = syncUrl.concat(syncUrl.split('?')[1] ? '&' : '?').concat(`${LOCUS.SYNCDEBUG}=${desync}`);
     }
 
+    // @ts-ignore
     return this.request({
       method: HTTP_VERBS.GET,
       uri: syncUrl
@@ -294,11 +334,11 @@ export default class MeetingRequest extends StatelessWebexPlugin {
   /**
    * Request to get the complete locus object
    * @param {Object} options
-   * @param {boolen} options.desync flag to get partial or whole locus object
+   * @param {boolean} options.desync flag to get partial or whole locus object
    * @param {String} options.locusUrl sync url to get ht elatest locus delta
    * @returns {Promise}
    */
-  getFullLocus(options) {
+  getFullLocus(options: { desync: boolean; locusUrl: string }) {
     let {locusUrl} = options;
     const {desync} = options;
 
@@ -307,6 +347,7 @@ export default class MeetingRequest extends StatelessWebexPlugin {
         locusUrl += `?${LOCUS.SYNCDEBUG}=${desync}`;
       }
 
+      // @ts-ignore
       return this.request({
         method: HTTP_VERBS.GET,
         uri: locusUrl
@@ -330,11 +371,16 @@ export default class MeetingRequest extends StatelessWebexPlugin {
    * @returns {Promise}
    * @private
    */
-  disconnectPhoneAudio({
+  private disconnectPhoneAudio({
     locusUrl,
     phoneUrl,
     correlationId,
-    selfId
+    selfId,
+  }: {
+    locusUrl: string;
+    phoneUrl: string;
+    correlationId: string;
+    selfId: string;
   }) {
     LoggerProxy.logger.info(
       `Meeting:request#disconnectPhoneAudio --> request phone ${phoneUrl} to leave`,
@@ -350,6 +396,7 @@ export default class MeetingRequest extends StatelessWebexPlugin {
       correlationId
     };
 
+    // @ts-ignore
     return this.request({
       method: HTTP_VERBS.PUT,
       uri,
@@ -378,7 +425,13 @@ export default class MeetingRequest extends StatelessWebexPlugin {
     selfId,
     deviceUrl: url,
     resourceId,
-    correlationId
+    correlationId,
+  }: {
+    locusUrl: string;
+    selfId: string;
+    deviceUrl: string;
+    resourceId: string;
+    correlationId: string;
   }) {
     LoggerProxy.logger.info(
       'Meeting:request#leaveMeeting --> Leaving a meeting',
@@ -388,6 +441,7 @@ export default class MeetingRequest extends StatelessWebexPlugin {
     const uri = `${locusUrl}/${PARTICIPANT}/${selfId}/${LEAVE}`;
     const body = {
       device: {
+        // @ts-ignore
         deviceType: this.config.meetings.deviceType,
         url
       },
@@ -395,6 +449,7 @@ export default class MeetingRequest extends StatelessWebexPlugin {
       correlationId
     };
 
+    // @ts-ignore
     return this.request({
       method: HTTP_VERBS.PUT,
       uri,
@@ -410,16 +465,18 @@ export default class MeetingRequest extends StatelessWebexPlugin {
    * @param {String} options.correlationId
    * @returns {Promise}
    */
-  acknowledgeMeeting(options) {
+  acknowledgeMeeting(options: { locusUrl: string; deviceUrl: string; correlationId: string }) {
     const uri = `${options.locusUrl}/${PARTICIPANT}/${ALERT}`;
     const body = {
       device: {
+        // @ts-ignore
         deviceType: this.config.meetings.deviceType,
         url: options.deviceUrl
       },
       correlationId: options.correlationId
     };
 
+    // @ts-ignore
     return this.request({
       method: HTTP_VERBS.PUT,
       uri,
@@ -435,7 +492,7 @@ export default class MeetingRequest extends StatelessWebexPlugin {
    * @param {String} options.id
    * @returns {Promise}
    */
-  recordMeeting(options) {
+  recordMeeting(options: { locusUrl: string; deviceUrl: string; id: string, recording: any, paused: any }) {
     const uri = `${options.locusUrl}/${CONTROLS}`;
     const body = {
       record: {
@@ -444,6 +501,7 @@ export default class MeetingRequest extends StatelessWebexPlugin {
       }
     };
 
+    // @ts-ignore
     return this.request({
       method: HTTP_VERBS.PATCH,
       uri,
@@ -459,6 +517,7 @@ export default class MeetingRequest extends StatelessWebexPlugin {
       }
     };
 
+    // @ts-ignore
     return this.request({
       method: HTTP_VERBS.PATCH,
       uri,
@@ -474,16 +533,18 @@ export default class MeetingRequest extends StatelessWebexPlugin {
    * @param {String} options.reason
    * @returns {Promise}
    */
-  declineMeeting(options) {
+  declineMeeting(options: { locusUrl: string; deviceUrl: string; reason: string }) {
     const uri = `${options.locusUrl}/${PARTICIPANT}/${DECLINE}`;
     const body = {
       device: {
+        // @ts-ignore
         deviceType: this.config.meetings.deviceType,
         url: options.deviceUrl
       },
-      ...(options.reason && {reason: options.reason})
+      ...(options.reason && {reason: options.reason}),
     };
 
+    // @ts-ignore
     return this.request({
       method: HTTP_VERBS.PUT,
       uri,
@@ -499,12 +560,20 @@ export default class MeetingRequest extends StatelessWebexPlugin {
    * @param {String} options.deviceUrl Url of a device
    * @param {String} options.resourceId Populated if you are paired to a device
    * @param {String} options.localMedias local sdps
+   * @param {Boolean} options.preferTranscoding false for multistream (Homer), true for transcoded media (Edonus)
    * @returns {Promise}
    */
-  remoteAudioVideoToggle(options) {
+  remoteAudioVideoToggle(options: {
+    selfId: string;
+    locusUrl: string;
+    deviceUrl: string;
+    resourceId: string;
+    localMedias: string;
+  } | any) {
     const uri = `${options.locusUrl}/${PARTICIPANT}/${options.selfId}/${MEDIA}`;
     const body = {
       device: {
+        // @ts-ignore
         deviceType: this.config.meetings.deviceType,
         url: options.deviceUrl
       },
@@ -517,6 +586,7 @@ export default class MeetingRequest extends StatelessWebexPlugin {
       }
     };
 
+    // @ts-ignore
     return this.request({
       method: HTTP_VERBS.PUT,
       uri,
@@ -534,8 +604,14 @@ export default class MeetingRequest extends StatelessWebexPlugin {
    * @param {String} options.uri floor grant uri
    * @returns {Promise}
    */
-  changeMeetingFloor(options) {
-    let floorReq = {disposition: options.disposition};
+  changeMeetingFloor(options: {
+    disposition: string;
+    personUrl: string;
+    deviceUrl: string;
+    resourceId: string;
+    uri: string;
+  } | any) {
+    let floorReq: any = {disposition: options.disposition};
 
     /* istanbul ignore else */
     if (options.disposition === FLOOR_ACTION.GRANTED) {
@@ -544,6 +620,7 @@ export default class MeetingRequest extends StatelessWebexPlugin {
           url: options.personUrl,
           devices: [
             {
+              // @ts-ignore
               deviceType: this.config.meetings.deviceType,
               url: options.deviceUrl
             }
@@ -556,7 +633,7 @@ export default class MeetingRequest extends StatelessWebexPlugin {
       };
     }
 
-    const body = {
+    const body: any = {
       floor: floorReq,
       resourceUrl: options.resourceUrl
     };
@@ -565,6 +642,7 @@ export default class MeetingRequest extends StatelessWebexPlugin {
       body.resourceToken = options?.resourceToken;
     }
 
+    // @ts-ignore
     return this.request({
       uri: options.uri,
       method: HTTP_VERBS.PUT,
@@ -580,7 +658,8 @@ export default class MeetingRequest extends StatelessWebexPlugin {
    * @param {String} options.tones a string of one or more DTMF tones to send
    * @returns {Promise}
    */
-  sendDTMF({locusUrl, deviceUrl, tones}) {
+  sendDTMF({ locusUrl, deviceUrl, tones }: { locusUrl: string; deviceUrl: string; tones: string }) {
+    // @ts-ignore
     return this.request({
       method: HTTP_VERBS.POST,
       uri: `${locusUrl}/${SEND_DTMF_ENDPOINT}`,
@@ -613,7 +692,19 @@ export default class MeetingRequest extends StatelessWebexPlugin {
     deviceUrl,
     layoutType,
     main,
-    content
+    content,
+  }: {
+    locusUrl: string;
+    deviceUrl: string;
+    layoutType: string;
+    main: {
+      width: number;
+      height: number;
+    };
+    content: {
+      width: number;
+      height: number;
+    };
   }) {
     // send main/content renderInfo only if both width and height are specified
     if (main && (!main.width || !main.height)) {
@@ -636,6 +727,7 @@ export default class MeetingRequest extends StatelessWebexPlugin {
         }
       } : undefined;
 
+    // @ts-ignore
     return this.request({
       method: HTTP_VERBS.PUT,
       uri: `${locusUrl}/${CONTROLS}`,
@@ -655,11 +747,10 @@ export default class MeetingRequest extends StatelessWebexPlugin {
    * @param {Url} options.locusUrl
    * @returns {Promise}
    */
-  endMeetingForAll({
-    locusUrl,
-  }) {
+  endMeetingForAll({ locusUrl }: { locusUrl: string }) {
     const uri = `${locusUrl}/${END}`;
 
+    // @ts-ignore
     return this.request({
       method: HTTP_VERBS.POST,
       uri
@@ -672,12 +763,33 @@ export default class MeetingRequest extends StatelessWebexPlugin {
    * @param {Url} options.keepAliveUrl
    * @returns {Promise}
    */
-  keepAlive({
-    keepAliveUrl,
-  }) {
+  keepAlive({ keepAliveUrl }: { keepAliveUrl: string }) {
+    // @ts-ignore
     return this.request({
       method: HTTP_VERBS.GET,
       uri: keepAliveUrl
     });
   }
+
+  /**
+   * Make a network request to send a reaction.
+   * @param {Object} options
+   * @param {Url} options.reactionChannelUrl
+   * @param {Reaction} options.reaction
+   * @param {string} options.senderID
+   * @returns {Promise}
+   */
+  sendReaction({ reactionChannelUrl, reaction, participantId }: { reactionChannelUrl: string, reaction: Reaction, participantId: string }) {
+    const uri = reactionChannelUrl;
+
+    // @ts-ignore
+    return this.request({
+      method: HTTP_VERBS.POST,
+      uri,
+      body: {
+        sender: {participantId},
+        reaction,
+      }
+    });
+  }
 }

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

@@ -13,7 +13,7 @@ const MeetingStateMachine = {
    * @param {Meeting} meetingRef A reference to a meeting instance
    * @returns {StateMachine}
    */
-  create(meetingRef) {
+  create(meetingRef: any) {
     if (!meetingRef) {
       throw new ParameterError('You must initialize the meeting state machine with a meeting reference.');
     }
@@ -44,7 +44,7 @@ const MeetingStateMachine = {
          * @param {Boolean} remote.remoteDeclined
          * @returns {String}
          */
-          to(remote) {
+          to(remote: { remoteAnswered: boolean; remoteDeclined: boolean }) {
             // other user answered the call
             if (remote.remoteAnswered) {
               return MEETING_STATE_MACHINE.STATES.ANSWERED;
@@ -114,7 +114,7 @@ const MeetingStateMachine = {
          * @param {Object} stop -- {remoteAnswered: {Boolean}, remoteDeclined: {Boolean}}
          * @returns {Boolean}
          */
-        onRemote(transition, stop) {
+        onRemote(transition: object, stop: object) {
           if (this.meeting) {
             Trigger.trigger(
               this.meeting,
@@ -136,7 +136,7 @@ const MeetingStateMachine = {
          * @param {String} type -- incoming call === INCOMING / or other meetings have a ring type of JOIN
          * @returns {Boolean}
          */
-        onRing(transition, type) {
+        onRing(transition: object, type: string) {
           if (this.meeting) {
             Trigger.trigger(
               this.meeting,
@@ -158,7 +158,7 @@ const MeetingStateMachine = {
          * @param {Error} error
          * @returns {Boolean}
          */
-        onEnterError(transition, error) {
+        onEnterError(transition: any, error: Error) {
           LoggerProxy.logger.error(`Meeting:state#onEnterError --> state->onEnterError#meeting.id: ${this.meeting.id} | Transition '${transition?.transition}' : ${transition?.from} -> ${transition?.to}, with error ${error}. Last states: ${this.history}`);
         },
         /**
@@ -166,7 +166,7 @@ const MeetingStateMachine = {
          * @param {Object} transition
          * @returns {Boolean}
          */
-        onAfterTransition(transition) {
+        onAfterTransition(transition: any) {
           LoggerProxy.logger.log(`Meeting:state#onAfterTransition --> state->onAfterTransition#meeting.id: ${this.meeting.id} | Transition '${transition.transition}' : ${transition.from} -> ${transition.to} executed. Last states: ${this.history}`);
         }
       },