@webex/plugin-meetings 2.35.3 → 2.36.0

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

@@ -17,13 +17,13 @@ import {
 } from '../constants';
 import ParameterError from '../common/errors/parameter';
 
-const MemberUtil = {};
+const MemberUtil: any = {};
 
 /**
  * @param {Object} participant the locus participant
  * @returns {Boolean}
  */
-MemberUtil.isUser = (participant) => participant && participant.type === _USER_;
+MemberUtil.isUser = (participant: any) => participant && participant.type === _USER_;
 
 MemberUtil.isModerator = (participant) => participant && participant.moderator;
 
@@ -31,13 +31,13 @@ MemberUtil.isModerator = (participant) => participant && participant.moderator;
  * @param {Object} participant the locus participant
  * @returns {Boolean}
  */
-MemberUtil.isGuest = (participant) => participant && participant.guest;
+MemberUtil.isGuest = (participant: any) => participant && participant.guest;
 
 /**
  * @param {Object} participant the locus participant
  * @returns {Boolean}
  */
-MemberUtil.isDevice = (participant) => participant && participant.type === _RESOURCE_ROOM_;
+MemberUtil.isDevice = (participant: any) => participant && participant.type === _RESOURCE_ROOM_;
 
 MemberUtil.isModeratorAssignmentProhibited = (participant) => participant && participant.moderatorAssignmentNotAllowed;
 
@@ -48,7 +48,7 @@ MemberUtil.isModeratorAssignmentProhibited = (participant) => participant && par
  * @param {String} id
  * @returns {Boolean}
  */
-MemberUtil.isSame = (participant, id) => participant &&
+MemberUtil.isSame = (participant: any, id: string) => participant &&
   (participant.id === id || participant.person && participant.person.id === id);
 
 /**
@@ -58,7 +58,7 @@ MemberUtil.isSame = (participant, id) => participant &&
  * @param {String} id
  * @returns {Boolean}
  */
-MemberUtil.isAssociatedSame = (participant, id) => participant &&
+MemberUtil.isAssociatedSame = (participant: any, id: string) => participant &&
 participant.associatedUsers &&
 participant.associatedUsers.some((user) => (user.id === id || user.person && user.person.id === id));
 
@@ -68,16 +68,17 @@ participant.associatedUsers.some((user) => (user.id === id || user.person && use
  * @param {String} status
  * @returns {Boolean}
  */
-MemberUtil.isNotAdmitted = (participant, isGuest, status) => participant &&
+MemberUtil.isNotAdmitted = (participant: any, isGuest: boolean, status: string) => participant &&
   participant.guest && ((participant.devices && participant.devices[0] &&
   participant.devices[0].intent && participant.devices[0].intent.type === _WAIT_ &&
+  // @ts-ignore
   isGuest && status === _IN_LOBBY_) || !status === _IN_MEETING_);
 
 /**
  * @param {Object} participant the locus participant
  * @returns {Boolean}
  */
-MemberUtil.isAudioMuted = (participant) => {
+MemberUtil.isAudioMuted = (participant: any) => {
   if (!participant) {
     throw new ParameterError('Audio could not be processed, participant is undefined.');
   }
@@ -99,7 +100,7 @@ MemberUtil.isAudioMuted = (participant) => {
  * @param {Object} participant the locus participant
  * @returns {Boolean}
  */
-MemberUtil.isVideoMuted = (participant) => {
+MemberUtil.isVideoMuted = (participant: any) => {
   if (!participant) {
     throw new ParameterError('Video could not be processed, participant is undefined.');
   }
@@ -111,7 +112,7 @@ MemberUtil.isVideoMuted = (participant) => {
  * @param {Object} participant the locus participant
  * @returns {Boolean}
  */
-MemberUtil.isHandRaised = (participant) => {
+MemberUtil.isHandRaised = (participant: any) => {
   if (!participant) {
     throw new ParameterError('Raise hand could not be processed, participant is undefined.');
   }
@@ -125,7 +126,7 @@ MemberUtil.isHandRaised = (participant) => {
  * @param {String} accessor
  * @returns {Boolean}
  */
-MemberUtil.isMuted = (status, accessor) => {
+MemberUtil.isMuted = (status: string, accessor: string) => {
   if (status) {
     if (status[accessor] === _RECEIVE_ONLY_) {
       return true;
@@ -143,7 +144,7 @@ MemberUtil.isMuted = (status, accessor) => {
  * @param {Object} controls
  * @returns {String|null}
  */
-MemberUtil.getRecordingMember = (controls) => {
+MemberUtil.getRecordingMember = (controls: any) => {
   if (!controls) {
     return null;
   }
@@ -158,7 +159,7 @@ MemberUtil.getRecordingMember = (controls) => {
  * @param {Object} participant the locus participant
  * @returns {Boolean}
  */
-MemberUtil.isRecording = (participant) => {
+MemberUtil.isRecording = (participant: any) => {
   if (!participant) {
     throw new ParameterError('Recording could not be processed, participant is undefined.');
   }
@@ -204,7 +205,7 @@ MemberUtil.isMutable = (isSelf, isDevice, isInMeeting, isMuted, type) => {
  * @param {Object} participant the locus participant
  * @returns {String}
  */
-MemberUtil.extractStatus = (participant) => {
+MemberUtil.extractStatus = (participant: any) => {
   if (!(participant && participant.devices && participant.devices.length)) {
     return _NOT_IN_MEETING_;
   }
@@ -231,7 +232,7 @@ MemberUtil.extractStatus = (participant) => {
  * @param {Object} participant the locus participant
  * @returns {String}
  */
-MemberUtil.extractId = (participant) => {
+MemberUtil.extractId = (participant: any) => {
   if (participant) {
     return participant.id;
   }
@@ -243,7 +244,7 @@ MemberUtil.extractId = (participant) => {
  * @param {Object} participant the locus participant
  * @returns {String}
  */
-MemberUtil.extractName = (participant) => {
+MemberUtil.extractName = (participant: any) => {
   if (participant && participant.person) {
     return participant.person.name;
   }

package/src/members/{collection.js → collection.ts}

@@ -4,6 +4,7 @@ import {MEETINGS} from '../constants';
  * @class MembersCollection
  */
 export default class MembersCollection {
+  members: any;
   namespace = MEETINGS;
 
   /**
@@ -26,7 +27,7 @@ export default class MembersCollection {
    * @param {String} id
    * @returns {Member}
    */
-  get(id) {
+  get(id: string) {
     return this.members[id];
   }
 

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

@@ -2,6 +2,7 @@
  * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
  */
 import {isEmpty} from 'lodash';
+// @ts-ignore
 import {StatelessWebexPlugin} from '@webex/webex-core';
 
 import {MEETINGS, EVENT_TRIGGERS, FLOOR_ACTION, CONTENT, WHITEBOARD} from '../constants';
@@ -60,6 +61,16 @@ import MembersUtil from './util';
  * @class Members
  */
 export default class Members extends StatelessWebexPlugin {
+  hostId: any;
+  locusUrl: any;
+  mediaShareContentId: any;
+  mediaShareWhiteboardId: any;
+  membersCollection: any;
+  membersRequest: any;
+  recordingId: any;
+  selfId: any;
+  type: any;
+
   namespace = MEETINGS;
 
   /**
@@ -68,7 +79,7 @@ export default class Members extends StatelessWebexPlugin {
    * @param {Object} options
    * @memberof Members
    */
-  constructor(attrs, options) {
+  constructor(attrs: any, options: object) {
     super({}, options);
     /**
      * The Members Request object to interact with server
@@ -77,6 +88,7 @@ export default class Members extends StatelessWebexPlugin {
      * @private
      * @memberof Members
     */
+   // @ts-ignore
     this.membersRequest = new MembersRequest({}, options);
     /**
      * The Members Collection cache
@@ -159,7 +171,7 @@ export default class Members extends StatelessWebexPlugin {
    * @private
    * @memberof Members
    */
-  locusSelfUpdate(payload) {
+  locusSelfUpdate(payload: { newSelf: any; oldSelf: any }) {
     let newSelfId = null;
     let oldSelfId = null;
 
@@ -209,7 +221,7 @@ export default class Members extends StatelessWebexPlugin {
    * @private
    * @memberof Members
    */
-  locusHostUpdate(payload) {
+  locusHostUpdate(payload: { newHost: any; oldHost: any }) {
     let newHostId = null;
     let oldHostId = null;
 
@@ -259,7 +271,7 @@ export default class Members extends StatelessWebexPlugin {
    * @private
    * @memberof Members
    */
-  locusParticipantsUpdate(payload) {
+  locusParticipantsUpdate(payload: { participants: object }) {
     if (payload) {
       const delta = this.handleLocusInfoUpdatedParticipants(payload);
       const full = this.handleMembersUpdate(delta); // SDK should propagate the full list for both delta and non delta updates
@@ -288,7 +300,7 @@ export default class Members extends StatelessWebexPlugin {
    * @private
    * @memberof Members
    */
-  locusMediaSharesUpdate(payload) {
+  locusMediaSharesUpdate(payload: { current: any; previous: any }) {
     const currentContent = payload.current?.content;
     const previousContent = payload.previous?.content;
     const currentWhiteboard = payload.current?.whiteboard;
@@ -370,7 +382,7 @@ export default class Members extends StatelessWebexPlugin {
    * @private
    * @memberof Members
    */
-  locusUrlUpdate(payload) {
+  locusUrlUpdate(payload: any) {
     if (payload) {
       this.setLocusUrl(null, payload);
     }
@@ -384,7 +396,7 @@ export default class Members extends StatelessWebexPlugin {
    * @private
    * @memberof Members
    */
-  locusFullStateTypeUpdate(payload) {
+  locusFullStateTypeUpdate(payload: { type: string }) {
     // TODO: at some point there could be a timing issue here, for updating each member
     // ie., if the type changes AND there is no locus update, then each member will not know the type of call
     // which means they cannot determine isMutable && isRemovable
@@ -403,7 +415,7 @@ export default class Members extends StatelessWebexPlugin {
    * @private
    * @memberof Members
    */
-  handleMembersUpdate(membersUpdate) {
+  private handleMembersUpdate(membersUpdate: any) {
     if (membersUpdate) {
       if (membersUpdate.updated) {
         this.constructMembers(membersUpdate.updated);
@@ -423,7 +435,7 @@ export default class Members extends StatelessWebexPlugin {
    * @private
    * @memberof Members
    */
-  constructMembers(list) {
+  private constructMembers(list: Array<any>) {
     list.forEach((member) => {
       this.membersCollection.set(member.id, member);
     });
@@ -436,7 +448,7 @@ export default class Members extends StatelessWebexPlugin {
    * @private
    * @memberof Members
    */
-  handleLocusInfoUpdatedParticipants(payload) {
+  private handleLocusInfoUpdatedParticipants(payload: any) {
     this.hostId = payload.hostId || this.hostId;
     this.selfId = payload.selfId || this.selfId;
     this.recordingId = payload.recordingId;
@@ -457,7 +469,7 @@ export default class Members extends StatelessWebexPlugin {
    * @public
    * @memberof Members
    */
-  setLocusUrl(locus, locusUrl = null) {
+  public setLocusUrl(locus: any, locusUrl: string = null) {
     if (locusUrl) {
       this.locusUrl = locusUrl;
     }
@@ -478,7 +490,7 @@ export default class Members extends StatelessWebexPlugin {
    * @public
    * @memberof Members
    */
-  setHostId(locus, hostId = null) {
+  public setHostId(locus: any, hostId: string = null) {
     if (hostId) {
       this.hostId = hostId;
     }
@@ -499,7 +511,7 @@ export default class Members extends StatelessWebexPlugin {
    * @public
    * @memberof Members
    */
-  setType(fullState, type = null) {
+  public setType(fullState: any, type: string = null) {
     if (type) {
       this.type = type;
     }
@@ -519,7 +531,7 @@ export default class Members extends StatelessWebexPlugin {
    * @returns {undefined}
    * @memberof Members
    */
-  setSelfId(locus, selfId = null) {
+  setSelfId(locus: any, selfId: string = null) {
     if (selfId) {
       this.selfId = selfId;
     }
@@ -539,7 +551,7 @@ export default class Members extends StatelessWebexPlugin {
    * @returns {undefined}
    * @memberof Members
    */
-  setMediaShareContentId(locus, contentId) {
+  setMediaShareContentId(locus: any, contentId?: string) {
     if (contentId) {
       this.mediaShareContentId = contentId;
     }
@@ -569,7 +581,7 @@ export default class Members extends StatelessWebexPlugin {
    * @returns {undefined}
    * @memberof Members
    */
-  setMediaShareWhiteboardId(locus, whiteboardId) {
+  setMediaShareWhiteboardId(locus: any, whiteboardId?: string) {
     if (whiteboardId) {
       this.mediaShareWhiteboardId = whiteboardId;
     }
@@ -600,7 +612,7 @@ export default class Members extends StatelessWebexPlugin {
    * @private
    * @memberof Members
    */
-  update(participants) {
+  private update(participants: Array<any>) {
     const membersUpdate = {added: [], updated: []};
 
     if (participants) {
@@ -649,7 +661,7 @@ export default class Members extends StatelessWebexPlugin {
    * @returns {Promise}
    * @memberof Members
    */
-  addMember(invitee, alertIfActive) {
+  addMember(invitee: any, alertIfActive?: boolean) {
     if (!this.locusUrl) {
       return Promise.reject(new ParameterError('The associated locus url for this meeting object must be defined.'));
     }
@@ -669,7 +681,7 @@ export default class Members extends StatelessWebexPlugin {
    * @returns {Promise}
    * @memberof Members
    */
-  cancelPhoneInvite(invitee) {
+  cancelPhoneInvite(invitee: any) {
     if (!this.locusUrl) {
       return Promise.reject(new ParameterError('The associated locus url for this meeting object must be defined.'));
     }
@@ -691,7 +703,7 @@ export default class Members extends StatelessWebexPlugin {
    * @public
    * @memberof Members
    */
-  admitMembers(memberIds) {
+  public admitMembers(memberIds: Array<any>) {
     if (isEmpty(memberIds)) {
       return Promise.reject(new ParameterError('No member ids provided to admit.'));
     }
@@ -707,7 +719,7 @@ export default class Members extends StatelessWebexPlugin {
    * @public
    * @memberof Members
    */
-  removeMember(memberId) {
+  public removeMember(memberId: string) {
     if (!this.locusUrl) {
       return Promise.reject(new ParameterError('The associated locus url for this meeting object must be defined.'));
     }
@@ -727,7 +739,7 @@ export default class Members extends StatelessWebexPlugin {
    * @public
    * @memberof Members
    */
-  muteMember(memberId, mute = true) {
+  public muteMember(memberId: string, mute: boolean = true) {
     if (!this.locusUrl) {
       return Promise.reject(new ParameterError('The associated locus url for this meetings members object must be defined.'));
     }
@@ -747,7 +759,7 @@ export default class Members extends StatelessWebexPlugin {
    * @public
    * @memberof Members
    */
-  raiseOrLowerHand(memberId, raise = true) {
+  public raiseOrLowerHand(memberId: string, raise: boolean = true) {
     if (!this.locusUrl) {
       return Promise.reject(new ParameterError('The associated locus url for this meetings members object must be defined.'));
     }
@@ -766,7 +778,7 @@ export default class Members extends StatelessWebexPlugin {
    * @public
    * @memberof Members
    */
-  lowerAllHands(requestingMemberId) {
+  public lowerAllHands(requestingMemberId: string) {
     if (!this.locusUrl) {
       return Promise.reject(new ParameterError('The associated locus url for this meetings members object must be defined.'));
     }
@@ -787,7 +799,7 @@ export default class Members extends StatelessWebexPlugin {
    * @public
    * @memberof Members
    */
-  transferHostToMember(memberId, moderator = true) {
+  public transferHostToMember(memberId: string, moderator: boolean = true) {
     if (!this.locusUrl) {
       return Promise.reject(new ParameterError('The associated locus url for this meetings members object must be defined.'));
     }
@@ -808,7 +820,8 @@ export default class Members extends StatelessWebexPlugin {
    * @public
    * @memberof Members
    */
-  sendDialPadKey(tones = '', memberId = '') {
+  public sendDialPadKey(tones: string = '', memberId: string = '') {
+    // @ts-ignore
     if (!tones && tones !== 0) {
       return Promise.reject(new ParameterError('DMTF tones must be passed in'));
     }

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

@@ -1,3 +1,4 @@
+// @ts-ignore
 import {StatelessWebexPlugin} from '@webex/webex-core';
 
 import {MEETINGS} from '../constants';
@@ -9,7 +10,7 @@ import MembersUtil from './util';
 /**
  * @class MembersRequest
  */
-export default class MembersRequest extends StatelessWebexPlugin {
+export default class MembersRequest extends StatelessWebexPlugin {  
   namespace = MEETINGS;
 
   /**
@@ -19,12 +20,13 @@ export default class MembersRequest extends StatelessWebexPlugin {
    * @throws {Error} if the options are not valid and complete, must have invitee with emailAddress OR email AND locusUrl
    * @memberof MembersRequest
    */
-  addMembers(options) {
+  addMembers(options: any) {
     if (!(!options || !options.invitee || (!options.invitee.emailAddress || !options.invitee.email || !options.invitee.phoneNumber) || !options.locusUrl)) {
       throw new ParameterError('invitee must be passed and the associated locus url for this meeting object must be defined.');
     }
     const requestParams = MembersUtil.getAddMemberRequestParams(options);
 
+    // @ts-ignore
     return this.request(requestParams);
   }
 
@@ -35,12 +37,13 @@ export default class MembersRequest extends StatelessWebexPlugin {
    * @throws {Error} if the options are not valid and complete, must have memberIds AND locusUrl
    * @memberof MembersRequest
    */
-  admitMember(options) {
+  admitMember(options: any) {
     if (!options || !options.locusUrl || !options.memberIds) {
       throw new ParameterError('memberIds must be an array passed and the associated locus url for this meeting object must be defined.');
     }
     const requestParams = MembersUtil.getAdmitMemberRequestParams(options);
 
+    // @ts-ignore
     return this.request(requestParams);
   }
 
@@ -51,6 +54,7 @@ export default class MembersRequest extends StatelessWebexPlugin {
 
     const requestParams = MembersUtil.getRemoveMemberRequestParams(options);
 
+    // @ts-ignore
     return this.request(requestParams);
   }
 
@@ -61,6 +65,7 @@ export default class MembersRequest extends StatelessWebexPlugin {
 
     const requestParams = MembersUtil.getMuteMemberRequestParams(options);
 
+    // @ts-ignore
     return this.request(requestParams);
   }
 
@@ -71,6 +76,7 @@ export default class MembersRequest extends StatelessWebexPlugin {
 
     const requestParams = MembersUtil.getRaiseHandMemberRequestParams(options);
 
+    // @ts-ignore
     return this.request(requestParams);
   }
 
@@ -81,6 +87,7 @@ export default class MembersRequest extends StatelessWebexPlugin {
 
     const requestParams = MembersUtil.getLowerAllHandsMemberRequestParams(options);
 
+    // @ts-ignore
     return this.request(requestParams);
   }
 
@@ -91,6 +98,7 @@ export default class MembersRequest extends StatelessWebexPlugin {
 
     const requestParams = MembersUtil.getTransferHostToMemberRequestParams(options);
 
+    // @ts-ignore
     return this.request(requestParams);
   }
 
@@ -103,13 +111,15 @@ export default class MembersRequest extends StatelessWebexPlugin {
    * @param {String} options.memberId ID of PSTN user
    * @returns {Promise}
    */
-  sendDialPadKey(options) {
+  sendDialPadKey(options: { locusUrl: string; url: string; tones: string; memberId: string }) {
+    // @ts-ignore
     if (!options || !options.locusUrl || !options.memberId || !options.url || !options.tones && options.tones !== 0) {
       throw new ParameterError('memberId must be defined, the associated locus url, the device url and DTMF tones for this meeting object must be defined.');
     }
 
     const requestParams = MembersUtil.generateSendDTMFRequestParams(options);
 
+    // @ts-ignore
     return this.request(requestParams);
   }
 
@@ -119,13 +129,14 @@ export default class MembersRequest extends StatelessWebexPlugin {
    * @throws {Error} if the options are not valid and complete, must have invitee with emailAddress OR email AND locusUrl
    * @memberof MembersRequest
    */
-  cancelPhoneInvite(options) {
+  cancelPhoneInvite(options: any) {
     if (!(options?.invitee?.phoneNumber || options?.locusUrl)) {
       throw new ParameterError('invitee must be passed and the associated locus url for this meeting object must be defined.');
     }
 
     const requestParams = MembersUtil.generateCancelInviteRequestParams(options);
 
+    // @ts-ignore
     return this.request(requestParams);
   }
 }

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

@@ -12,7 +12,7 @@ import {
   _REMOVE_
 } from '../constants';
 
-const MembersUtil = {};
+const MembersUtil: any = {};
 
 /**
  * @param {Object} invitee with emailAddress, email or phoneNumber
@@ -20,7 +20,7 @@ const MembersUtil = {};
  * @param {Boolean} alertIfActive
  * @returns {Object} the format object
  */
-MembersUtil.generateAddMemberOptions = (invitee, locusUrl, alertIfActive) => ({
+MembersUtil.generateAddMemberOptions = (invitee: object, locusUrl: string, alertIfActive: boolean) => ({
   invitee,
   locusUrl,
   alertIfActive
@@ -31,7 +31,7 @@ MembersUtil.generateAddMemberOptions = (invitee, locusUrl, alertIfActive) => ({
  * @param {String} locusUrl
  * @returns {Object} the format object
  */
-MembersUtil.generateAdmitMemberOptions = (memberIds, locusUrl) => ({
+MembersUtil.generateAdmitMemberOptions = (memberIds: Array<any>, locusUrl: string) => ({
   locusUrl,
   memberIds
 });
@@ -40,7 +40,7 @@ MembersUtil.generateAdmitMemberOptions = (memberIds, locusUrl) => ({
  * @param {Object} options with {invitee: {emailAddress, email, phoneNumber}, alertIfActive}
  * @returns {Object} with {invitees: [{address}], alertIfActive}
  */
-MembersUtil.getAddMemberBody = (options) => ({
+MembersUtil.getAddMemberBody = (options: any) => ({
   invitees: [
     {
       address: options.invitee.emailAddress || options.invitee.email || options.invitee.phoneNumber
@@ -53,7 +53,7 @@ MembersUtil.getAddMemberBody = (options) => ({
  * @param {Object} options with {memberIds}
  * @returns {Object} admit with {memberIds}
  */
-MembersUtil.getAdmitMemberRequestBody = (options) => ({
+MembersUtil.getAdmitMemberRequestBody = (options: any) => ({
   admit: {participantIds: options.memberIds}
 });
 
@@ -61,7 +61,7 @@ MembersUtil.getAdmitMemberRequestBody = (options) => ({
  * @param {Object} format with {memberIds, locusUrl}
  * @returns {Object} the request parameters (method, uri, body) needed to make a admitMember request
  */
-MembersUtil.getAdmitMemberRequestParams = (format) => {
+MembersUtil.getAdmitMemberRequestParams = (format: any) => {
   const body = MembersUtil.getAdmitMemberRequestBody(format);
   const uri = `${format.locusUrl}/${CONTROLS}`;
 
@@ -76,7 +76,7 @@ MembersUtil.getAdmitMemberRequestParams = (format) => {
  * @param {Object} format with {invitee {emailAddress, email, phoneNumber}, locusUrl, alertIfActive}
  * @returns {Object} the request parameters (method, uri, body) needed to make a addMember request
  */
-MembersUtil.getAddMemberRequestParams = (format) => {
+MembersUtil.getAddMemberRequestParams = (format: any) => {
   const body = MembersUtil.getAddMemberBody(format);
   const requestParams = {
     method: HTTP_VERBS.PUT,

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

@@ -1,5 +1,3 @@
-
-
 const errorDescription = {
   UNKNOWN_CALL_FAILURE: 'UnknownCallFailure',
   LOCUS_RATE_LIMITED_INCOMING: 'LocusRateLimitedIncoming',