@webex/plugin-meetings 3.0.0-beta.2 → 3.0.0-beta.20

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

@@ -1,11 +1,8 @@
+// @ts-ignore
 import {StatelessWebexPlugin} from '@webex/webex-core';
 
 import LoggerProxy from '../common/logs/logger-proxy';
-import {
-  HTTP_VERBS,
-  API,
-  RESOURCE
-} from '../constants';
+import {HTTP_VERBS, API, RESOURCE} from '../constants';
 
 /**
  * @class MeetingRequest
@@ -14,15 +11,18 @@ export default class MeetingRequest extends StatelessWebexPlugin {
   /**
    *  get all the active meetings for the user
    * @returns {Array} return locus array
-  */
+   */
   getActiveMeetings() {
+    // @ts-ignore
     return this.request({
       api: API.LOCUS,
-      resource: RESOURCE.LOCI
+      resource: RESOURCE.LOCI,
     })
       .then((res) => this.determineRedirections(res.body))
       .catch((error) => {
-        LoggerProxy.logger.error(`Meetings:request#getActiveMeetings --> failed to get locus details, ${error}`);
+        LoggerProxy.logger.error(
+          `Meetings:request#getActiveMeetings --> failed to get locus details, ${error}`
+        );
       });
   }
 
@@ -31,18 +31,19 @@ export default class MeetingRequest extends StatelessWebexPlugin {
    * @returns {Promise<object>} geoHintInfo
    */
   fetchGeoHint() {
+    // @ts-ignore
     return this.webex.internal.services.fetchClientRegionInfo();
   }
 
   /**
    * get user meeting preference information
    * @returns {Promise<object>} getMeetingPreferences
-  */
+   */
   getMeetingPreferences() {
+    // @ts-ignore
     return this.webex.internal.services.getMeetingPreferences();
   }
 
-
   // locus federation, determines and populate locus if the responseBody has remote URLs to fetch locus details
 
   /**
@@ -50,23 +51,29 @@ export default class MeetingRequest extends StatelessWebexPlugin {
    * @param {object} responseBody determine the locus and fetch them if a remoteUrl is given
    * @returns {Promise}  returns locusObject array
    */
-  determineRedirections(responseBody) {
+  determineRedirections(responseBody: any) {
     if (responseBody.remoteLocusClusterUrls && responseBody.remoteLocusClusterUrls.length) {
-      return Promise.all(responseBody.remoteLocusClusterUrls.map((url) => this.request({
-        method: HTTP_VERBS.GET,
-        url,
-        runWhitelistedDomains: true // allows auth token for whitelisted domain
-      })
-        .then((res) => {
-          responseBody.loci = responseBody.loci.concat(res.body.loci);
-          responseBody.locusUrls = responseBody.locusUrls.concat(res.body.locusUrls);
+      return Promise.all(
+        responseBody.remoteLocusClusterUrls.map((url) =>
+          // @ts-ignore
+          this.request({
+            method: HTTP_VERBS.GET,
+            url,
+            runWhitelistedDomains: true, // allows auth token for whitelisted domain
+          })
+            .then((res) => {
+              responseBody.loci = responseBody.loci.concat(res.body.loci);
+              responseBody.locusUrls = responseBody.locusUrls.concat(res.body.locusUrls);
 
-          return Promise.resolve(responseBody);
-        })
-        .catch((error) => {
-          LoggerProxy.logger.error(`Meetings:request#determineRedirections --> failed to get locus details from url: ${url}, reason: ${error}`);
-        })))
-        .then(() => Promise.resolve(responseBody));
+              return Promise.resolve(responseBody);
+            })
+            .catch((error) => {
+              LoggerProxy.logger.error(
+                `Meetings:request#determineRedirections --> failed to get locus details from url: ${url}, reason: ${error}`
+              );
+            })
+        )
+      ).then(() => Promise.resolve(responseBody));
     }
 
     return Promise.resolve(responseBody);

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

@@ -7,30 +7,30 @@ import {
   LOCUSEVENT,
   CORRELATION_ID,
   EVENT_TRIGGERS,
-  ROAP
+  ROAP,
 } from '../constants';
 import LoggerProxy from '../common/logs/logger-proxy';
 import Trigger from '../common/events/trigger-proxy';
 
 /**
-  * Meetings Media Codec Missing Event
-  * Emitted when H.264 codec is not
-  * found in the browser.
-  * @event media:codec:missing
-  * @instance
-  * @memberof MeetingsUtil
-  */
+ * Meetings Media Codec Missing Event
+ * Emitted when H.264 codec is not
+ * found in the browser.
+ * @event media:codec:missing
+ * @instance
+ * @memberof MeetingsUtil
+ */
 
 /**
-  * Meetings Media Codec Loaded Event
-  * Emitted when H.264 codec has been
-  * loaded in the browser.
-  * @event media:codec:loaded
-  * @instance
-  * @memberof MeetingsUtil
-  */
+ * Meetings Media Codec Loaded Event
+ * Emitted when H.264 codec has been
+ * loaded in the browser.
+ * @event media:codec:loaded
+ * @instance
+ * @memberof MeetingsUtil
+ */
 
-const MeetingsUtil = {};
+const MeetingsUtil: any = {};
 
 MeetingsUtil.getMeetingAddedType = (type) => (type === _LOCUS_ID_ ? _INCOMING_ : _CREATED_);
 
@@ -42,23 +42,20 @@ MeetingsUtil.handleRoapMercury = (envelope, meetingCollection) => {
     const meeting = meetingCollection.getByKey(CORRELATION_ID, data.correlationId);
 
     if (meeting) {
-      const {
-        seq, messageType, tieBreaker, errorType, errorCause
-      } = data.message;
+      const {seq, messageType, tieBreaker, errorType, errorCause} = data.message;
 
       if (messageType === ROAP.ROAP_TYPES.TURN_DISCOVERY_RESPONSE) {
         // turn discovery is not part of normal roap protocol and so we are not handling it
         // through the usual roap state machine
         meeting.roap.turnDiscovery.handleTurnDiscoveryResponse(data.message);
-      }
-      else {
+      } else {
         const roapMessage = {
           seq,
           messageType,
           sdp: data.message.sdps?.length > 0 ? data.message.sdps[0] : undefined,
           tieBreaker,
           errorType,
-          errorCause
+          errorCause,
         };
 
         meeting.mediaProperties.webrtcMediaConnection.roapMessageReceived(roapMessage);
@@ -116,15 +113,15 @@ MeetingsUtil.hasH264Codec = async () => {
       hasCodec = true;
     }
     pc.close();
-  }
-  catch (error) {
-    LoggerProxy.logger.warn('Meetings:util#hasH264Codec --> Error creating peerConnection for H.264 test.');
+  } catch (error) {
+    LoggerProxy.logger.warn(
+      'Meetings:util#hasH264Codec --> Error creating peerConnection for H.264 test.'
+    );
   }
 
   return hasCodec;
 };
 
-
 /**
  * Notifies the user whether or not the H.264
  * codec is present. Will continuously check
@@ -136,13 +133,16 @@ MeetingsUtil.hasH264Codec = async () => {
  * @param {boolean} options.disableNotifications Default is false. Boolean to enable/disable notification and events
  * @returns {undefined}
  */
-MeetingsUtil.checkH264Support = async function checkH264Support(options) {
+MeetingsUtil.checkH264Support = async function checkH264Support(options: {
+  firstChecked: number;
+  disableNotifications: boolean;
+}) {
   const {hasH264Codec} = MeetingsUtil;
   const {firstChecked, disableNotifications} = options || {};
   const delay = 5e3; // ms
   const maxDuration = 3e5; // ms
-  const shouldTrigger = (firstChecked === undefined);
-  const shouldStopChecking = firstChecked && (Date.now() - firstChecked) >= maxDuration;
+  const shouldTrigger = firstChecked === undefined;
+  const shouldStopChecking = firstChecked && Date.now() - firstChecked >= maxDuration;
 
   // Disable notifications and start H.264 download only
   if (disableNotifications) {
@@ -157,7 +157,7 @@ MeetingsUtil.checkH264Support = async function checkH264Support(options) {
       this,
       {
         file: 'meetings/util',
-        function: 'checkH264Support'
+        function: 'checkH264Support',
       },
       EVENT_TRIGGERS.MEDIA_CODEC_LOADED
     );
@@ -168,7 +168,9 @@ MeetingsUtil.checkH264Support = async function checkH264Support(options) {
 
   // Stop checking if past the timelimit
   if (shouldStopChecking) {
-    LoggerProxy.logger.error('Meetings:util#checkH264Support --> Timed out waiting for H264 codec to load.');
+    LoggerProxy.logger.error(
+      'Meetings:util#checkH264Support --> Timed out waiting for H264 codec to load.'
+    );
 
     return;
   }
@@ -179,7 +181,7 @@ MeetingsUtil.checkH264Support = async function checkH264Support(options) {
       this,
       {
         file: 'meetings/util',
-        function: 'checkH264Support'
+        function: 'checkH264Support',
       },
       EVENT_TRIGGERS.MEDIA_CODEC_MISSING
     );

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

@@ -1,19 +1,38 @@
 /*!
  * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
  */
-import {
-  MEETINGS,
-  _IN_LOBBY_,
-  _NOT_IN_MEETING_,
-  _IN_MEETING_
-} from '../constants';
+import {MEETINGS, _IN_LOBBY_, _NOT_IN_MEETING_, _IN_MEETING_} from '../constants';
 
-import MemberUtil from './util.js';
+import MemberUtil from './util';
 
 /**
  * @class Member
  */
 export default class Member {
+  associatedUser: any;
+  id: any;
+  isAudioMuted: any;
+  isContentSharing: any;
+  isDevice: any;
+  isGuest: any;
+  isHandRaised: any;
+  isHost: any;
+  isInLobby: any;
+  isInMeeting: any;
+  isModerator: any;
+  isModeratorAssignmentProhibited: any;
+  isMutable: any;
+  isNotAdmitted: any;
+  isRecording: any;
+  isRemovable: any;
+  isSelf: any;
+  isUser: any;
+  isVideoMuted: any;
+  name: any;
+  participant: any;
+  status: any;
+  supportsBreakouts: boolean;
+  type: any;
   namespace = MEETINGS;
 
   /**
@@ -26,14 +45,24 @@ export default class Member {
    * @returns {Member}
    * @memberof Member
    */
-  constructor(participant, options = {}) {
+  constructor(
+    participant: object,
+    options:
+      | {
+          selfId: string;
+          hostId: string;
+          contentSharingId: string;
+          type: string;
+        }
+      | any = {}
+  ) {
     /**
      * The server participant object
      * @instance
      * @type {Object}
      * @private
      * @memberof Member
-    */
+     */
     this.participant = null;
     /**
      * The member id
@@ -41,7 +70,7 @@ export default class Member {
      * @type {String}
      * @public
      * @memberof Member
-    */
+     */
     this.id = null;
     /**
      * The member name
@@ -49,34 +78,41 @@ export default class Member {
      * @type {String}
      * @public
      * @memberof Member
-    */
+     */
     this.name = null;
     /**
      * @instance
      * @type {Boolean}
      * @public
      * @memberof Member
-    */
+     */
     this.isAudioMuted = null;
     /**
      * @instance
      * @type {Boolean}
      * @public
      * @memberof Member
-    */
+     */
     this.isVideoMuted = null;
     /**
      * @instance
      * @type {Boolean}
      * @public
      * @memberof Member
-    */
+     */
     this.isHandRaised = null;
     /**
-      * @instance
-      * @type {Boolean}
-      * @public
-      * @memberof Member
+     * @instance
+     * @type {Boolean}
+     * @public
+     * @memberof Member
+     */
+    this.supportsBreakouts = null;
+    /**
+     * @instance
+     * @type {Boolean}
+     * @public
+     * @memberof Member
      */
     this.isSelf = null;
     /**
@@ -84,113 +120,113 @@ export default class Member {
      * @type {Boolean}
      * @public
      * @memberof Member
-    */
+     */
     this.isHost = null;
     /**
      * @instance
      * @type {Boolean}
      * @public
      * @memberof Member
-    */
+     */
     this.isGuest = null;
     /**
      * @instance
      * @type {Boolean}
      * @public
      * @memberof Member
-    */
+     */
     this.isInLobby = null;
     /**
      * @instance
      * @type {Boolean}
      * @public
      * @memberof Member
-    */
+     */
     this.isInMeeting = null;
     /**
      * @instance
      * @type {Boolean}
      * @public
      * @memberof Member
-    */
+     */
     this.isNotAdmitted = null;
     /**
      * @instance
      * @type {Boolean}
      * @public
      * @memberof Member
-    */
+     */
     this.isContentSharing = null;
     /**
      * @instance
      * @type {Boolean}
      * @public
      * @memberof Member
-    */
+     */
     this.status = null;
     /**
      * @instance
      * @type {Boolean}
      * @public
      * @memberof Member
-    */
+     */
     this.isDevice = null;
     /**
      * @instance
      * @type {Boolean}
      * @public
      * @memberof Member
-    */
+     */
     this.isUser = null;
     /**
-         * Is this member associated to another user by way of pairing (typical of devices)
+     * Is this member associated to another user by way of pairing (typical of devices)
      * @instance
      * @type {String}
      * @public
      * @memberof Member
-    */
+     */
     this.associatedUser = null;
     /**
      * @instance
      * @type {Boolean}
      * @public
      * @memberof Member
-    */
+     */
     this.isRecording = null;
     /**
      * @instance
      * @type {Boolean}
      * @public
      * @memberof Member
-    */
+     */
     this.isMutable = null;
     /**
      * @instance
      * @type {Boolean}
      * @public
      * @memberof Member
-    */
+     */
     this.isRemovable = null;
     /**
      * @instance
      * @type {String}
      * @private
      * @memberof Member
-    */
+     */
     this.type = null;
     /**
      * @instance
      * @type {Boolean}
      * @public
      * @memberof Member
-    */
+     */
     this.isModerator = null;
     /**
      * @instance
      * @type {Boolean}
      * @public
      * @memberof Member
-    */
+     */
     this.isModeratorAssignmentProhibited = null;
     // TODO: more participant types
     // such as native client, web client, is a device, what type of phone, etc
@@ -206,7 +242,7 @@ export default class Member {
    * @private
    * @memberof Member
    */
-  processParticipant(participant) {
+  private processParticipant(participant: object) {
     this.participant = participant;
     if (participant) {
       this.id = MemberUtil.extractId(participant);
@@ -214,11 +250,13 @@ export default class Member {
       this.isAudioMuted = MemberUtil.isAudioMuted(participant);
       this.isVideoMuted = MemberUtil.isVideoMuted(participant);
       this.isHandRaised = MemberUtil.isHandRaised(participant);
+      this.supportsBreakouts = MemberUtil.isBreakoutsSupported(participant);
       this.isGuest = MemberUtil.isGuest(participant);
       this.isUser = MemberUtil.isUser(participant);
       this.isDevice = MemberUtil.isDevice(participant);
       this.isModerator = MemberUtil.isModerator(participant);
-      this.isModeratorAssignmentProhibited = MemberUtil.isModeratorAssignmentProhibited(participant);
+      this.isModeratorAssignmentProhibited =
+        MemberUtil.isModeratorAssignmentProhibited(participant);
       this.processStatus(participant);
       // must be done last
       this.isNotAdmitted = MemberUtil.isNotAdmitted(participant, this.isGuest, this.status);
@@ -233,7 +271,7 @@ export default class Member {
    * @private
    * @memberof Member
    */
-  processParticipantOptions(participant, options) {
+  private processParticipantOptions(participant: object, options: any) {
     if (participant && options) {
       this.processIsSelf(participant, options.selfId);
       this.processIsHost(participant, options.hostId);
@@ -249,11 +287,22 @@ export default class Member {
    * @private
    * @memberof Member
    */
-  processMember() {
+  private processMember() {
     // must occur after self, guest, meeting, and type properties are calculated
-    this.isRemovable = MemberUtil.isRemovable(this.isSelf, this.isGuest, this.isInMeeting, this.type);
+    this.isRemovable = MemberUtil.isRemovable(
+      this.isSelf,
+      this.isGuest,
+      this.isInMeeting,
+      this.type
+    );
     // must occur after self, device, meeting, mute status, and type properties are calculated
-    this.isMutable = MemberUtil.isMutable(this.isSelf, this.isDevice, this.isInMeeting, this.isAudioMuted, this.type);
+    this.isMutable = MemberUtil.isMutable(
+      this.isSelf,
+      this.isDevice,
+      this.isInMeeting,
+      this.isAudioMuted,
+      this.type
+    );
   }
 
   /**
@@ -263,7 +312,7 @@ export default class Member {
    * @private
    * @memberof Member
    */
-  processStatus(participant) {
+  private processStatus(participant: object) {
     this.status = MemberUtil.extractStatus(participant);
     switch (this.status) {
       case _IN_LOBBY_:
@@ -291,7 +340,7 @@ export default class Member {
    * @public
    * @memberof Member
    */
-  setIsContentSharing(flag) {
+  public setIsContentSharing(flag: boolean) {
     this.isContentSharing = flag;
   }
 
@@ -302,7 +351,7 @@ export default class Member {
    * @public
    * @memberof Member
    */
-  setIsHost(flag) {
+  public setIsHost(flag: boolean) {
     this.isHost = flag;
   }
 
@@ -313,7 +362,7 @@ export default class Member {
    * @public
    * @memberof Member
    */
-  setIsSelf(flag) {
+  public setIsSelf(flag: boolean) {
     this.isSelf = flag;
   }
 
@@ -325,11 +374,10 @@ export default class Member {
    * @public
    * @memberof Member
    */
-  processIsContentSharing(participant, sharingId) {
+  public processIsContentSharing(participant: object, sharingId: string) {
     if (MemberUtil.isUser(participant)) {
       this.isContentSharing = MemberUtil.isSame(participant, sharingId);
-    }
-    else if (MemberUtil.isDevice(participant)) {
+    } else if (MemberUtil.isDevice(participant)) {
       this.isContentSharing = MemberUtil.isAssociatedSame(participant, sharingId);
     }
   }
@@ -342,7 +390,7 @@ export default class Member {
    * @public
    * @memberof Member
    */
-  processIsRecording(participant, recordingId) {
+  public processIsRecording(participant: object, recordingId: string) {
     this.isRecording = MemberUtil.isSame(participant, recordingId);
   }
 
@@ -354,11 +402,10 @@ export default class Member {
    * @private
    * @memberof Member
    */
-  processIsSelf(participant, selfId) {
+  private processIsSelf(participant: object, selfId: string) {
     if (MemberUtil.isUser(participant)) {
       this.isSelf = MemberUtil.isSame(participant, selfId);
-    }
-    else if (MemberUtil.isDevice(participant)) {
+    } else if (MemberUtil.isDevice(participant)) {
       this.isSelf = MemberUtil.isAssociatedSame(participant, selfId);
       this.associatedUser = selfId;
     }
@@ -372,11 +419,10 @@ export default class Member {
    * @private
    * @memberof Member
    */
-  processIsHost(participant, hostId) {
+  private processIsHost(participant: object, hostId: string) {
     if (MemberUtil.isUser(participant)) {
       this.isHost = MemberUtil.isSame(participant, hostId);
-    }
-    else if (MemberUtil.isDevice(participant)) {
+    } else if (MemberUtil.isDevice(participant)) {
       this.isHost = MemberUtil.isAssociatedSame(participant, hostId);
     }
   }
@@ -388,7 +434,7 @@ export default class Member {
    * @private
    * @memberof Member
    */
-  processType(type) {
+  private processType(type: string) {
     this.type = type;
   }
 }