@webex/plugin-meetings 2.37.1 → 2.38.0

package/src/meeting/index.ts

@@ -30,6 +30,7 @@ import ReconnectionManager from '../reconnection-manager';
 import MeetingRequest from './request';
 import Members from '../members/index';
 import MeetingUtil from './util';
+import RecordingUtil from '../recording-controller/util';
 import MediaUtil from '../media/util';
 import Transcription from '../transcription';
 import PasswordError from '../common/errors/password-error';
@@ -88,6 +89,7 @@ import {SkinTones, Reactions} from '../reactions/reactions';
 import {Reaction, ReactionType, SkinToneType} from '../reactions/reactions.type';
 
 import InMeetingActions from './in-meeting-actions';
+import RecordingController from '../recording-controller';
 
 const {isBrowser} = BrowserDetection();
 
@@ -452,6 +454,7 @@ export default class Meeting extends StatelessWebexPlugin {
   passwordStatus: string;
   queuedMediaUpdates: any[];
   recording: any;
+  recordingController: RecordingController;
   requiredCaptcha: any;
   shareStatus: string;
   statsAnalyzer: StatsAnalyzer;
@@ -885,6 +888,7 @@ export default class Meeting extends StatelessWebexPlugin {
      */
     // @ts-ignore - Fix type
     this.locusInfo = new LocusInfo(this.updateMeetingObject.bind(this), this.webex, this.id);
+
     // We had to add listeners first before setting up the locus instance
     /**
      * @instance
@@ -984,6 +988,20 @@ export default class Meeting extends StatelessWebexPlugin {
      */
     this.keepAliveTimerId = null;
 
+    /**
+     * The class that helps to control recording functions: start, stop, pause, resume, etc
+     * @instance
+     * @type {RecordingController}
+     * @public
+     * @memberof Meeting
+     */
+    this.recordingController = new RecordingController(this.meetingRequest, {
+      serviceUrl: this.locusInfo?.links?.services?.record?.url,
+      sessionId: this.locusInfo?.fullState?.sessionId,
+      locusUrl: this.locusInfo?.url,
+      displayHints: [],
+    });
+
     this.setUpLocusInfoListeners();
     this.locusInfo.init(attrs.locus ? attrs.locus : {});
     this.hasJoinedOnce = false;
@@ -1155,22 +1173,25 @@ export default class Meeting extends StatelessWebexPlugin {
     // we have to pass the wbxappapi hostname as the siteFullName parameter
     const {hostname} = new URL(this.requiredCaptcha.refreshURL);
 
-    return this.meetingRequest
-      .refreshCaptcha({
-        captchaRefreshUrl: `${this.requiredCaptcha.refreshURL}&siteFullName=${hostname}`,
-        captchaId: this.requiredCaptcha.captchaId,
-      })
-      .then((response) => {
-        this.requiredCaptcha.captchaId = response.body.captchaID;
-        this.requiredCaptcha.verificationImageURL = response.body.verificationImageURL;
-        this.requiredCaptcha.verificationAudioURL = response.body.verificationAudioURL;
-      })
-      .catch((error) => {
-        LoggerProxy.logger.error(
-          `Meeting:index#refreshCaptcha --> Error Unable to refresh captcha for ${this.destination} - ${error}`
-        );
-        throw error;
-      });
+    return (
+      this.meetingRequest
+        // @ts-ignore
+        .refreshCaptcha({
+          captchaRefreshUrl: `${this.requiredCaptcha.refreshURL}&siteFullName=${hostname}`,
+          captchaId: this.requiredCaptcha.captchaId,
+        })
+        .then((response) => {
+          this.requiredCaptcha.captchaId = response.body.captchaID;
+          this.requiredCaptcha.verificationImageURL = response.body.verificationImageURL;
+          this.requiredCaptcha.verificationAudioURL = response.body.verificationAudioURL;
+        })
+        .catch((error) => {
+          LoggerProxy.logger.error(
+            `Meeting:index#refreshCaptcha --> Error Unable to refresh captcha for ${this.destination} - ${error}`
+          );
+          throw error;
+        })
+    );
   }
 
   /**
@@ -1183,6 +1204,7 @@ export default class Meeting extends StatelessWebexPlugin {
     // meeting update listeners
     this.setUpLocusInfoSelfListener();
     this.setUpLocusInfoMeetingListener();
+    this.setUpLocusServicesListener();
     // members update listeners
     this.setUpLocusFullStateListener();
     this.setUpLocusUrlListener();
@@ -1997,6 +2019,23 @@ export default class Meeting extends StatelessWebexPlugin {
       this.members.locusUrlUpdate(payload);
       this.locusUrl = payload;
       this.locusId = this.locusUrl?.split('/').pop();
+      this.recordingController.setLocusUrl(this.locusUrl);
+    });
+  }
+
+  /**
+   * Set up the locus info service link listener
+   * update the locusInfo for recording controller
+   * does not currently re-emit the event as it's internal only
+   * payload is unused
+   * @returns {undefined}
+   * @private
+   * @memberof Meeting
+   */
+  private setUpLocusServicesListener() {
+    this.locusInfo.on(LOCUSINFO.EVENTS.LINKS_SERVICES, (payload) => {
+      this.recordingController.setServiceUrl(payload?.services?.record?.url);
+      this.recordingController.setSessionId(this.locusInfo?.fullState?.sessionId);
     });
   }
 
@@ -2046,10 +2085,10 @@ export default class Meeting extends StatelessWebexPlugin {
           canAdmitParticipant: MeetingUtil.canAdmitParticipant(payload.info.userDisplayHints),
           canLock: MeetingUtil.canUserLock(payload.info.userDisplayHints),
           canUnlock: MeetingUtil.canUserUnlock(payload.info.userDisplayHints),
-          canStartRecording: MeetingUtil.canUserRecord(payload.info.userDisplayHints),
-          canStopRecording: MeetingUtil.canUserStop(payload.info.userDisplayHints),
-          canPauseRecording: MeetingUtil.canUserPause(payload.info.userDisplayHints),
-          canResumeRecording: MeetingUtil.canUserResume(payload.info.userDisplayHints),
+          canStartRecording: RecordingUtil.canUserStart(payload.info.userDisplayHints),
+          canStopRecording: RecordingUtil.canUserStop(payload.info.userDisplayHints),
+          canPauseRecording: RecordingUtil.canUserPause(payload.info.userDisplayHints),
+          canResumeRecording: RecordingUtil.canUserResume(payload.info.userDisplayHints),
           canRaiseHand: MeetingUtil.canUserRaiseHand(payload.info.userDisplayHints),
           canLowerAllHands: MeetingUtil.canUserLowerAllHands(payload.info.userDisplayHints),
           canLowerSomeoneElsesHand: MeetingUtil.canUserLowerSomeoneElsesHand(
@@ -2073,6 +2112,8 @@ export default class Meeting extends StatelessWebexPlugin {
           waitingForOthersToJoin: MeetingUtil.waitingForOthersToJoin(payload.info.userDisplayHints),
         });
 
+        this.recordingController.setDisplayHints(payload.info.userDisplayHints);
+
         if (changed) {
           Trigger.trigger(
             this,
@@ -2294,7 +2335,7 @@ export default class Meeting extends StatelessWebexPlugin {
           .catch((error) => {
             // @ts-ignore
             LoggerProxy.logger.error(
-              `Meeting:index#setUpLocusInfoMeetingListener --> REMOTE_RESPONSE. Issue with leave for meeting, meeting still in collection: ${this.meeting}, error: ${error}`
+              `Meeting:index#setUpLocusInfoMeetingListener --> REMOTE_RESPONSE. Issue with leave for meeting, meeting still in collection: ${this}, error: ${error}`
             );
           });
       }
@@ -2329,7 +2370,7 @@ export default class Meeting extends StatelessWebexPlugin {
           .catch((error) => {
             // @ts-ignore
             LoggerProxy.logger.error(
-              `Meeting:index#setUpLocusInfoMeetingListener --> DESTROY_MEETING. Issue with leave for meeting, meeting still in collection: ${this.meeting}, error: ${error}`
+              `Meeting:index#setUpLocusInfoMeetingListener --> DESTROY_MEETING. Issue with leave for meeting, meeting still in collection: ${this}, error: ${error}`
             );
           });
       } else {
@@ -2571,6 +2612,7 @@ export default class Meeting extends StatelessWebexPlugin {
       this.locusUrl = locusMeetingObject?.url || webexMeetingInfo?.locusUrl || this.locusUrl;
       // @ts-ignore - config coming from registerPlugin
       this.setSipUri(
+        // @ts-ignore
         this.config.experimental.enableUnifiedMeetings
           ? locusMeetingObject?.info.sipUri || webexMeetingInfo?.sipUrl
           : locusMeetingObject?.info.sipUri || webexMeetingInfo?.sipMeetingUri || this.sipUri
@@ -3667,6 +3709,7 @@ export default class Meeting extends StatelessWebexPlugin {
       // @ts-ignore - fix type
       const {
         body: {webSocketUrl},
+        // @ts-ignore
       } = await this.request({
         method: HTTP_VERBS.POST,
         uri: datachannelUrl,
@@ -3980,28 +4023,31 @@ export default class Meeting extends StatelessWebexPlugin {
 
     if (!this.dialInUrl) this.dialInUrl = `dialin:///${uuid.v4()}`;
 
-    return this.meetingRequest
-      .dialIn({
-        correlationId,
-        dialInUrl: this.dialInUrl,
-        locusUrl,
-        clientUrl: this.deviceUrl,
-      })
-      .then((res) => {
-        this.locusInfo.onFullLocus(res.body.locus);
-      })
-      .catch((error) => {
-        Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.ADD_DIAL_IN_FAILURE, {
-          correlation_id: this.correlationId,
-          dial_in_url: this.dialInUrl,
-          locus_id: locusUrl.split('/').pop(),
-          client_url: this.deviceUrl,
-          reason: error.error?.message,
-          stack: error.stack,
-        });
+    return (
+      this.meetingRequest
+        // @ts-ignore
+        .dialIn({
+          correlationId,
+          dialInUrl: this.dialInUrl,
+          locusUrl,
+          clientUrl: this.deviceUrl,
+        })
+        .then((res) => {
+          this.locusInfo.onFullLocus(res.body.locus);
+        })
+        .catch((error) => {
+          Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.ADD_DIAL_IN_FAILURE, {
+            correlation_id: this.correlationId,
+            dial_in_url: this.dialInUrl,
+            locus_id: locusUrl.split('/').pop(),
+            client_url: this.deviceUrl,
+            reason: error.error?.message,
+            stack: error.stack,
+          });
 
-        return Promise.reject(error);
-      });
+          return Promise.reject(error);
+        })
+    );
   }
 
   /**
@@ -4018,29 +4064,32 @@ export default class Meeting extends StatelessWebexPlugin {
 
     if (!this.dialOutUrl) this.dialOutUrl = `dialout:///${uuid.v4()}`;
 
-    return this.meetingRequest
-      .dialOut({
-        correlationId,
-        dialOutUrl: this.dialOutUrl,
-        phoneNumber,
-        locusUrl,
-        clientUrl: this.deviceUrl,
-      })
-      .then((res) => {
-        this.locusInfo.onFullLocus(res.body.locus);
-      })
-      .catch((error) => {
-        Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.ADD_DIAL_OUT_FAILURE, {
-          correlation_id: this.correlationId,
-          dial_out_url: this.dialOutUrl,
-          locus_id: locusUrl.split('/').pop(),
-          client_url: this.deviceUrl,
-          reason: error.error?.message,
-          stack: error.stack,
-        });
+    return (
+      this.meetingRequest
+        // @ts-ignore
+        .dialOut({
+          correlationId,
+          dialOutUrl: this.dialOutUrl,
+          phoneNumber,
+          locusUrl,
+          clientUrl: this.deviceUrl,
+        })
+        .then((res) => {
+          this.locusInfo.onFullLocus(res.body.locus);
+        })
+        .catch((error) => {
+          Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.ADD_DIAL_OUT_FAILURE, {
+            correlation_id: this.correlationId,
+            dial_out_url: this.dialOutUrl,
+            locus_id: locusUrl.split('/').pop(),
+            client_url: this.deviceUrl,
+            reason: error.error?.message,
+            stack: error.stack,
+          });
 
-        return Promise.reject(error);
-      });
+          return Promise.reject(error);
+        })
+    );
   }
 
   /**
@@ -4374,6 +4423,7 @@ export default class Meeting extends StatelessWebexPlugin {
       // Add ip address info if geo hint is present
       // @ts-ignore fix type
       options.data.intervalMetadata.peerReflexiveIP =
+        // @ts-ignore
         this.webex.meetings.geoHintInfo?.clientAddress ||
         options.data.intervalMetadata.peerReflexiveIP ||
         MQA_STATS.DEFAULT_IP;
@@ -4855,10 +4905,11 @@ export default class Meeting extends StatelessWebexPlugin {
             // we actually get a OFFER from the server and a GLAR condition happens
             if (startShare) {
               // We are assuming that the clients are connected when doing an update
+              // @ts-ignore
               return this.share();
             }
 
-            throw error;
+            return Promise.resolve();
           })
           .then(() =>
             logRequest(
@@ -5498,7 +5549,7 @@ export default class Meeting extends StatelessWebexPlugin {
    * @memberof Meeting
    */
   public startRecording() {
-    return MeetingUtil.startRecording(this.meetingRequest, this.locusUrl, this.locusInfo);
+    return this.recordingController.startRecording();
   }
 
   /**
@@ -5508,7 +5559,7 @@ export default class Meeting extends StatelessWebexPlugin {
    * @memberof Meeting
    */
   public stopRecording() {
-    return MeetingUtil.stopRecording(this.meetingRequest, this.locusUrl, this.locusInfo);
+    return this.recordingController.stopRecording();
   }
 
   /**
@@ -5518,7 +5569,7 @@ export default class Meeting extends StatelessWebexPlugin {
    * @memberof Meeting
    */
   public pauseRecording() {
-    return MeetingUtil.pauseRecording(this.meetingRequest, this.locusUrl, this.locusInfo);
+    return this.recordingController.pauseRecording();
   }
 
   /**
@@ -5528,7 +5579,7 @@ export default class Meeting extends StatelessWebexPlugin {
    * @memberof Meeting
    */
   public resumeRecording() {
-    return MeetingUtil.resumeRecording(this.meetingRequest, this.locusUrl, this.locusInfo);
+    return this.recordingController.resumeRecording();
   }
 
   /**

package/src/meeting/request.ts

@@ -496,37 +496,6 @@ export default class MeetingRequest extends StatelessWebexPlugin {
     });
   }
 
-  /**
-   * Make a network request to acknowledge a meeting
-   * @param {Object} options
-   * @param {String} options.locusUrl
-   * @param {String} options.deviceUrl
-   * @param {String} options.id
-   * @returns {Promise}
-   */
-  recordMeeting(options: {
-    locusUrl: string;
-    deviceUrl: string;
-    id: string;
-    recording: any;
-    paused: any;
-  }) {
-    const uri = `${options.locusUrl}/${CONTROLS}`;
-    const body = {
-      record: {
-        recording: options.recording,
-        paused: options.paused,
-      },
-    };
-
-    // @ts-ignore
-    return this.request({
-      method: HTTP_VERBS.PATCH,
-      uri,
-      body,
-    });
-  }
-
   lockMeeting(options) {
     const uri = `${options.locusUrl}/${CONTROLS}`;
     const body = {

package/src/meeting/util.ts

@@ -411,66 +411,6 @@ MeetingUtil.canUserUnlock = (displayHints) =>
   displayHints.includes(DISPLAY_HINTS.LOCK_CONTROL_UNLOCK) &&
   displayHints.includes(DISPLAY_HINTS.LOCK_STATUS_LOCKED);
 
-MeetingUtil.canUserRecord = (displayHints) =>
-  displayHints.includes(DISPLAY_HINTS.RECORDING_CONTROL_START);
-
-MeetingUtil.canUserPause = (displayHints) =>
-  displayHints.includes(DISPLAY_HINTS.RECORDING_CONTROL_PAUSE);
-
-MeetingUtil.canUserResume = (displayHints) =>
-  displayHints.includes(DISPLAY_HINTS.RECORDING_CONTROL_RESUME);
-
-MeetingUtil.canUserStop = (displayHints) =>
-  displayHints.includes(DISPLAY_HINTS.RECORDING_CONTROL_STOP);
-
-MeetingUtil.startRecording = (request, locusUrl, locusInfo) => {
-  const displayHints = MeetingUtil.getUserDisplayHintsFromLocusInfo(locusInfo);
-
-  if (MeetingUtil.canUserRecord(displayHints)) {
-    return request.recordMeeting({locusUrl, recording: true, paused: false});
-  }
-
-  return Promise.reject(
-    new PermissionError('Start recording not allowed, due to moderator property.')
-  );
-};
-
-MeetingUtil.pauseRecording = (request, locusUrl, locusInfo) => {
-  const displayHints = MeetingUtil.getUserDisplayHintsFromLocusInfo(locusInfo);
-
-  if (MeetingUtil.canUserPause(displayHints)) {
-    return request.recordMeeting({locusUrl, recording: true, paused: true});
-  }
-
-  return Promise.reject(
-    new PermissionError('Pause recording not allowed, due to moderator property.')
-  );
-};
-
-MeetingUtil.resumeRecording = (request, locusUrl, locusInfo) => {
-  const displayHints = MeetingUtil.getUserDisplayHintsFromLocusInfo(locusInfo);
-
-  if (MeetingUtil.canUserResume(displayHints)) {
-    return request.recordMeeting({locusUrl, recording: true, paused: false});
-  }
-
-  return Promise.reject(
-    new PermissionError('Resume recording not allowed, due to moderator property.')
-  );
-};
-
-MeetingUtil.stopRecording = (request, locusUrl, locusInfo) => {
-  const displayHints = MeetingUtil.getUserDisplayHintsFromLocusInfo(locusInfo);
-
-  if (MeetingUtil.canUserStop(displayHints)) {
-    return request.recordMeeting({locusUrl, recording: false, paused: false});
-  }
-
-  return Promise.reject(
-    new PermissionError('Stop recording not allowed, due to moderator property.')
-  );
-};
-
 MeetingUtil.canUserRaiseHand = (displayHints) => displayHints.includes(DISPLAY_HINTS.RAISE_HAND);
 
 MeetingUtil.canUserLowerAllHands = (displayHints) =>

package/src/meeting-info/meeting-info-v2.ts

@@ -19,6 +19,7 @@ export class MeetingInfoV2PasswordError extends Error {
   meetingInfo: any;
   sdkMessage: any;
   wbxAppApiCode: any;
+  body: any;
 
   /**
    *
@@ -70,6 +71,7 @@ export class MeetingInfoV2CaptchaError extends Error {
   isPasswordRequired: any;
   sdkMessage: any;
   wbxAppApiCode: any;
+  body: any;
   /**
    *
    * @constructor

package/src/meetings/index.ts

@@ -221,6 +221,7 @@ export default class Meetings extends WebexPlugin {
       // @ts-ignore
       this.meetingCollection.getByKey(
         CORRELATION_ID,
+        // @ts-ignore
         MeetingsUtil.checkForCorrelationId(this.webex.internal.device.url, data.locus)
       ) ||
       this.meetingCollection.getByKey(
@@ -440,11 +441,14 @@ export default class Meetings extends WebexPlugin {
        */
       // @ts-ignore
       this.meetingInfo = this.config.experimental.enableUnifiedMeetings
-        ? new MeetingInfoV2(this.webex)
-        : new MeetingInfo(this.webex);
+        ? // @ts-ignore
+          new MeetingInfoV2(this.webex)
+        : // @ts-ignore
+          new MeetingInfo(this.webex);
       // @ts-ignore
       this.personalMeetingRoom = new PersonalMeetingRoom(
         {meetingInfo: this.meetingInfo},
+        // @ts-ignore
         {parent: this.webex}
       );
 
@@ -554,6 +558,7 @@ export default class Meetings extends WebexPlugin {
         // @ts-ignore
         .then(() =>
           LoggerProxy.logger.info(
+            // @ts-ignore
             `Meetings:index#register --> INFO, Device registered ${this.webex.internal.device.url}`
           )
         )
@@ -607,8 +612,8 @@ export default class Meetings extends WebexPlugin {
 
     this.stopListeningForEvents();
 
-    // @ts-ignore
     return (
+      // @ts-ignore
       this.webex.internal.mercury
         .disconnect()
         // @ts-ignore

package/src/meetings/request.ts

@@ -53,9 +53,9 @@ export default class MeetingRequest extends StatelessWebexPlugin {
    */
   determineRedirections(responseBody: any) {
     if (responseBody.remoteLocusClusterUrls && responseBody.remoteLocusClusterUrls.length) {
-      // @ts-ignore
       return Promise.all(
         responseBody.remoteLocusClusterUrls.map((url) =>
+          // @ts-ignore
           this.request({
             method: HTTP_VERBS.GET,
             url,

package/src/member/util.ts

@@ -72,7 +72,7 @@ MemberUtil.isAssociatedSame = (participant: any, id: string) =>
  * @param {String} status
  * @returns {Boolean}
  */
-MemberUtil.isNotAdmitted = (participant: any, isGuest: boolean, status: string) =>
+MemberUtil.isNotAdmitted = (participant: any, isGuest: boolean, status: string): boolean =>
   participant &&
   participant.guest &&
   ((participant.devices &&
@@ -82,6 +82,7 @@ MemberUtil.isNotAdmitted = (participant: any, isGuest: boolean, status: string)
     // @ts-ignore
     isGuest &&
     status === _IN_LOBBY_) ||
+    // @ts-ignore
     !status === _IN_MEETING_);
 
 /**

package/src/members/request.ts

@@ -140,6 +140,7 @@ export default class MembersRequest extends StatelessWebexPlugin {
       !options.locusUrl ||
       !options.memberId ||
       !options.url ||
+      // @ts-ignore
       (!options.tones && options.tones !== 0)
     ) {
       throw new ParameterError(

package/src/reachability/index.ts

@@ -261,6 +261,7 @@ export default class Reachability {
 
         // @ts-ignore
         LoggerProxy.logger.log(
+          // @ts-ignore
           `Reachability:index#onIceGatheringStateChange --> Successfully pinged ${peerConnection.key}:`,
           elapsed
         );
@@ -284,8 +285,8 @@ export default class Reachability {
       if (e.candidate && String(e.candidate.type).toLowerCase() === SERVER_REFLEXIVE) {
         const elapsed = this.getElapsedTime(peerConnection);
 
-        // @ts-ignore
         LoggerProxy.logger.log(
+          // @ts-ignore
           `Reachability:index#onIceCandidate --> Successfully pinged ${peerConnection.key}:`,
           elapsed
         );

package/src/reactions/reactions.type.ts

@@ -5,7 +5,8 @@ export type EmoticonData = {
 };
 
 export type SkinTone = EmoticonData;
-export type Reaction = ReactionData & {
+// @ts-ignore
+export type Reaction = EmoticonData & {
   tone?: SkinTone;
 };
 

package/src/recording-controller/enums.ts

@@ -0,0 +1,8 @@
+enum RecordingAction {
+  Start = 'Start',
+  Stop = 'Stop',
+  Pause = 'Pause',
+  Resume = 'Resume',
+}
+
+export default RecordingAction;