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

package/src/member/util.js

@@ -1,254 +0,0 @@
-import {
-  _USER_,
-  _RESOURCE_ROOM_,
-  _OBSERVE_,
-  _WAIT_,
-  _LEFT_,
-  _JOINED_,
-  _IDLE_,
-  _IN_LOBBY_,
-  _NOT_IN_MEETING_,
-  _IN_MEETING_,
-  AUDIO_STATUS,
-  VIDEO_STATUS,
-  _SEND_RECEIVE_,
-  _RECEIVE_ONLY_,
-  _CALL_
-} from '../constants';
-import ParameterError from '../common/errors/parameter';
-
-const MemberUtil = {};
-
-/**
- * @param {Object} participant the locus participant
- * @returns {Boolean}
- */
-MemberUtil.isUser = (participant) => participant && participant.type === _USER_;
-
-MemberUtil.isModerator = (participant) => participant && participant.moderator;
-
-/**
- * @param {Object} participant the locus participant
- * @returns {Boolean}
- */
-MemberUtil.isGuest = (participant) => participant && participant.guest;
-
-/**
- * @param {Object} participant the locus participant
- * @returns {Boolean}
- */
-MemberUtil.isDevice = (participant) => participant && participant.type === _RESOURCE_ROOM_;
-
-MemberUtil.isModeratorAssignmentProhibited = (participant) => participant && participant.moderatorAssignmentNotAllowed;
-
-/**
- * checks to see if the participant id is the same as the passed id
- * there are multiple ids that can be used
- * @param {Object} participant the locus participant
- * @param {String} id
- * @returns {Boolean}
- */
-MemberUtil.isSame = (participant, id) => participant &&
-  (participant.id === id || participant.person && participant.person.id === id);
-
-/**
- * checks to see if the participant id is the same as the passed id for associated devices
- * there are multiple ids that can be used
- * @param {Object} participant the locus participant
- * @param {String} id
- * @returns {Boolean}
- */
-MemberUtil.isAssociatedSame = (participant, id) => participant &&
-participant.associatedUsers &&
-participant.associatedUsers.some((user) => (user.id === id || user.person && user.person.id === id));
-
-/**
- * @param {Object} participant the locus participant
- * @param {Boolean} isGuest
- * @param {String} status
- * @returns {Boolean}
- */
-MemberUtil.isNotAdmitted = (participant, isGuest, status) => participant &&
-  participant.guest && ((participant.devices && participant.devices[0] &&
-  participant.devices[0].intent && participant.devices[0].intent.type === _WAIT_ &&
-  isGuest && status === _IN_LOBBY_) || !status === _IN_MEETING_);
-
-/**
- * @param {Object} participant the locus participant
- * @returns {Boolean}
- */
-MemberUtil.isAudioMuted = (participant) => {
-  if (!participant) {
-    throw new ParameterError('Audio could not be processed, participant is undefined.');
-  }
-  const mutedStatus = MemberUtil.isMuted(participant.status, AUDIO_STATUS);
-
-  if (participant.controls && participant.controls.audio) {
-    if (participant.controls.audio.muted) {
-      return true;
-    }
-    if (mutedStatus) {
-      return true;
-    }
-  }
-
-  return false;
-};
-
-/**
- * @param {Object} participant the locus participant
- * @returns {Boolean}
- */
-MemberUtil.isVideoMuted = (participant) => {
-  if (!participant) {
-    throw new ParameterError('Video could not be processed, participant is undefined.');
-  }
-
-  return MemberUtil.isMuted(participant.status, VIDEO_STATUS);
-};
-
-/**
- * @param {Object} participant the locus participant
- * @returns {Boolean}
- */
-MemberUtil.isHandRaised = (participant) => {
-  if (!participant) {
-    throw new ParameterError('Raise hand could not be processed, participant is undefined.');
-  }
-
-  return participant.controls?.hand?.raised || false;
-};
-
-/**
- * utility method for audio/video muted status
- * @param {String} status
- * @param {String} accessor
- * @returns {Boolean}
- */
-MemberUtil.isMuted = (status, accessor) => {
-  if (status) {
-    if (status[accessor] === _RECEIVE_ONLY_) {
-      return true;
-    }
-    if (status[accessor] === _SEND_RECEIVE_) {
-      return false;
-    }
-  }
-
-  return null;
-};
-
-/**
- * utility method for getting the recording member for later comparison
- * @param {Object} controls
- * @returns {String|null}
- */
-MemberUtil.getRecordingMember = (controls) => {
-  if (!controls) {
-    return null;
-  }
-  if (controls.record && controls.record.recording && controls.record.meta) {
-    return controls.record.meta.modifiedBy;
-  }
-
-  return null;
-};
-
-/**
- * @param {Object} participant the locus participant
- * @returns {Boolean}
- */
-MemberUtil.isRecording = (participant) => {
-  if (!participant) {
-    throw new ParameterError('Recording could not be processed, participant is undefined.');
-  }
-  if (participant.controls && participant.controls.localRecord) {
-    return participant.controls.localRecord.recording;
-  }
-
-  return false;
-};
-
-MemberUtil.isRemovable = (isSelf, isGuest, isInMeeting, type) => {
-  if (isGuest || isSelf) {
-    return false;
-  }
-  if (type === _CALL_) {
-    return false;
-  }
-  if (isInMeeting) {
-    return true;
-  }
-
-  return false;
-};
-
-MemberUtil.isMutable = (isSelf, isDevice, isInMeeting, isMuted, type) => {
-  if (!isInMeeting) {
-    return false;
-  }
-  if (isMuted) {
-    return false;
-  }
-  if (type === _CALL_) {
-    return false;
-  }
-  if (isSelf || isDevice) {
-    return true;
-  }
-
-  return false;
-};
-
-/**
- * @param {Object} participant the locus participant
- * @returns {String}
- */
-MemberUtil.extractStatus = (participant) => {
-  if (!(participant && participant.devices && participant.devices.length)) {
-    return _NOT_IN_MEETING_;
-  }
-  if (participant.state === _JOINED_) {
-    return _IN_MEETING_;
-  }
-  if (participant.state === _IDLE_) {
-    if (participant.devices && participant.devices.length > 0) {
-      const foundDevice = participant.devices.find((device) => device.intent && (device.intent.type === _WAIT_ || device.intent.type === _OBSERVE_));
-
-      return foundDevice ? _IN_LOBBY_ : _NOT_IN_MEETING_;
-    }
-
-    return _NOT_IN_MEETING_;
-  }
-  if (participant.state === _LEFT_) {
-    return _NOT_IN_MEETING_;
-  }
-
-  return _NOT_IN_MEETING_;
-};
-
-/**
- * @param {Object} participant the locus participant
- * @returns {String}
- */
-MemberUtil.extractId = (participant) => {
-  if (participant) {
-    return participant.id;
-  }
-
-  return null;
-};
-
-/**
- * @param {Object} participant the locus participant
- * @returns {String}
- */
-MemberUtil.extractName = (participant) => {
-  if (participant && participant.person) {
-    return participant.person.name;
-  }
-
-  return null;
-};
-
-export default MemberUtil;

package/src/members/request.js

@@ -1,131 +0,0 @@
-import {StatelessWebexPlugin} from '@webex/webex-core';
-
-import {MEETINGS} from '../constants';
-import ParameterError from '../common/errors/parameter';
-
-import MembersUtil from './util';
-
-
-/**
- * @class MembersRequest
- */
-export default class MembersRequest extends StatelessWebexPlugin {
-  namespace = MEETINGS;
-
-  /**
-   *
-   * @param {Object} options with format of {invitee: string, locusUrl: string}
-   * @returns {Promise}
-   * @throws {Error} if the options are not valid and complete, must have invitee with emailAddress OR email AND locusUrl
-   * @memberof MembersRequest
-   */
-  addMembers(options) {
-    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);
-
-    return this.request(requestParams);
-  }
-
-  /**
-   *
-   * @param {Object} options
-   * @returns {Promise}
-   * @throws {Error} if the options are not valid and complete, must have memberIds AND locusUrl
-   * @memberof MembersRequest
-   */
-  admitMember(options) {
-    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);
-
-    return this.request(requestParams);
-  }
-
-  removeMember(options) {
-    if (!options || !options.locusUrl || !options.memberId) {
-      throw new ParameterError('memberId must be defined, and the associated locus url for this meeting object must be defined.');
-    }
-
-    const requestParams = MembersUtil.getRemoveMemberRequestParams(options);
-
-    return this.request(requestParams);
-  }
-
-  muteMember(options) {
-    if (!options || !options.locusUrl || !options.memberId) {
-      throw new ParameterError('memberId must be defined, and the associated locus url for this meeting object must be defined.');
-    }
-
-    const requestParams = MembersUtil.getMuteMemberRequestParams(options);
-
-    return this.request(requestParams);
-  }
-
-  raiseOrLowerHandMember(options) {
-    if (!options || !options.locusUrl || !options.memberId) {
-      throw new ParameterError('memberId must be defined, and the associated locus url for this meeting object must be defined.');
-    }
-
-    const requestParams = MembersUtil.getRaiseHandMemberRequestParams(options);
-
-    return this.request(requestParams);
-  }
-
-  lowerAllHandsMember(options) {
-    if (!options || !options.locusUrl || !options.requestingParticipantId) {
-      throw new ParameterError('requestingParticipantId must be defined, and the associated locus url for this meeting object must be defined.');
-    }
-
-    const requestParams = MembersUtil.getLowerAllHandsMemberRequestParams(options);
-
-    return this.request(requestParams);
-  }
-
-  transferHostToMember(options) {
-    if (!options || !options.locusUrl || !options.memberId || !options.moderator) {
-      throw new ParameterError('memberId must be defined, the associated locus url, and the moderator for this meeting object must be defined.');
-    }
-
-    const requestParams = MembersUtil.getTransferHostToMemberRequestParams(options);
-
-    return this.request(requestParams);
-  }
-
-  /**
-   * Sends a request to the DTMF endpoint to send tones
-   * @param {Object} options
-   * @param {String} options.locusUrl
-   * @param {String} options.url device url SIP user
-   * @param {String} options.tones a string of one or more DTMF tones to send
-   * @param {String} options.memberId ID of PSTN user
-   * @returns {Promise}
-   */
-  sendDialPadKey(options) {
-    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);
-
-    return this.request(requestParams);
-  }
-
-  /**
-   * @param {Object} options with format of {invitee: string, locusUrl: string}
-   * @returns {Promise}
-   * @throws {Error} if the options are not valid and complete, must have invitee with emailAddress OR email AND locusUrl
-   * @memberof MembersRequest
-   */
-  cancelPhoneInvite(options) {
-    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);
-
-    return this.request(requestParams);
-  }
-}

package/src/members/util.js

@@ -1,258 +0,0 @@
-import uuid from 'uuid';
-
-import {
-  HTTP_VERBS,
-  CONTROLS,
-  _FORCED_,
-  LEAVE,
-  PARTICIPANT,
-  VALID_EMAIL_ADDRESS,
-  DIALER_REGEX,
-  SEND_DTMF_ENDPOINT,
-  _REMOVE_
-} from '../constants';
-
-const MembersUtil = {};
-
-/**
- * @param {Object} invitee with emailAddress, email or phoneNumber
- * @param {String} locusUrl
- * @param {Boolean} alertIfActive
- * @returns {Object} the format object
- */
-MembersUtil.generateAddMemberOptions = (invitee, locusUrl, alertIfActive) => ({
-  invitee,
-  locusUrl,
-  alertIfActive
-});
-
-/**
- * @param {Array} memberIds
- * @param {String} locusUrl
- * @returns {Object} the format object
- */
-MembersUtil.generateAdmitMemberOptions = (memberIds, locusUrl) => ({
-  locusUrl,
-  memberIds
-});
-
-/**
- * @param {Object} options with {invitee: {emailAddress, email, phoneNumber}, alertIfActive}
- * @returns {Object} with {invitees: [{address}], alertIfActive}
- */
-MembersUtil.getAddMemberBody = (options) => ({
-  invitees: [
-    {
-      address: options.invitee.emailAddress || options.invitee.email || options.invitee.phoneNumber
-    }
-  ],
-  alertIfActive: options.alertIfActive
-});
-
-/**
- * @param {Object} options with {memberIds}
- * @returns {Object} admit with {memberIds}
- */
-MembersUtil.getAdmitMemberRequestBody = (options) => ({
-  admit: {participantIds: options.memberIds}
-});
-
-/**
- * @param {Object} format with {memberIds, locusUrl}
- * @returns {Object} the request parameters (method, uri, body) needed to make a admitMember request
- */
-MembersUtil.getAdmitMemberRequestParams = (format) => {
-  const body = MembersUtil.getAdmitMemberRequestBody(format);
-  const uri = `${format.locusUrl}/${CONTROLS}`;
-
-  return {
-    method: HTTP_VERBS.PUT,
-    uri,
-    body
-  };
-};
-
-/**
- * @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) => {
-  const body = MembersUtil.getAddMemberBody(format);
-  const requestParams = {
-    method: HTTP_VERBS.PUT,
-    uri: format.locusUrl,
-    body
-  };
-
-  return requestParams;
-};
-
-MembersUtil.isInvalidInvitee = (invitee) => {
-  if (!(invitee && (invitee.email || invitee.emailAddress || invitee.phoneNumber))) {
-    return true;
-  }
-
-  if (invitee.phoneNumber) {
-    return !DIALER_REGEX.E164_FORMAT.test(invitee.phoneNumber);
-  }
-
-  return !VALID_EMAIL_ADDRESS.test(invitee.email || invitee.emailAddress);
-};
-
-MembersUtil.getRemoveMemberRequestParams = (options) => {
-  const body = {
-    reason: options.reason
-  };
-  const uri = `${options.locusUrl}/${PARTICIPANT}/${options.memberId}/${LEAVE}`;
-
-  return {
-    method: HTTP_VERBS.PUT,
-    uri,
-    body
-  };
-};
-
-MembersUtil.generateTransferHostMemberOptions = (transfer, moderator, locusUrl) => ({
-  moderator,
-  locusUrl,
-  memberId: transfer
-});
-
-MembersUtil.generateRemoveMemberOptions = (removal, locusUrl) => ({
-  reason: _FORCED_,
-  memberId: removal,
-  locusUrl
-});
-
-MembersUtil.generateMuteMemberOptions = (memberId, status, locusUrl) => ({
-  memberId,
-  muted: status,
-  locusUrl
-});
-
-MembersUtil.generateRaiseHandMemberOptions = (memberId, status, locusUrl) => ({
-  memberId,
-  raised: status,
-  locusUrl
-});
-
-MembersUtil.generateLowerAllHandsMemberOptions = (requestingParticipantId, locusUrl) => ({
-  requestingParticipantId,
-  locusUrl
-});
-
-MembersUtil.getMuteMemberRequestParams = (options) => {
-  const body = {
-    audio: {
-      muted: options.muted
-    }
-  };
-  const uri = `${options.locusUrl}/${PARTICIPANT}/${options.memberId}/${CONTROLS}`;
-
-  return {
-    method: HTTP_VERBS.PATCH,
-    uri,
-    body
-  };
-};
-
-MembersUtil.getRaiseHandMemberRequestParams = (options) => {
-  const body = {
-    hand: {
-      raised: options.raised
-    }
-  };
-  const uri = `${options.locusUrl}/${PARTICIPANT}/${options.memberId}/${CONTROLS}`;
-
-  return {
-    method: HTTP_VERBS.PATCH,
-    uri,
-    body
-  };
-};
-
-MembersUtil.getLowerAllHandsMemberRequestParams = (options) => {
-  const body = {
-    hand: {
-      raised: false
-    },
-    requestingParticipantId: options.requestingParticipantId
-  };
-  const uri = `${options.locusUrl}/${CONTROLS}`;
-
-  return {
-    method: HTTP_VERBS.PATCH,
-    uri,
-    body
-  };
-};
-
-MembersUtil.getTransferHostToMemberRequestParams = (options) => {
-  const body = {
-    role: {
-      moderator: options.moderator
-    }
-  };
-  const uri = `${options.locusUrl}/${PARTICIPANT}/${options.memberId}/${CONTROLS}`;
-
-  return {
-    method: HTTP_VERBS.PATCH,
-    uri,
-    body
-  };
-};
-
-MembersUtil.genderateSendDTMFOptions = (url, tones, memberId, locusUrl) => ({
-  url,
-  tones,
-  memberId,
-  locusUrl
-});
-
-MembersUtil.generateSendDTMFRequestParams = ({
-  url, tones, memberId, locusUrl
-}) => {
-  const body = {
-    device: {
-      url
-    },
-    memberId,
-    dtmf: {
-      correlationId: uuid.v4(),
-      tones,
-      direction: 'transmit'
-    }
-  };
-  const uri = `${locusUrl}/${PARTICIPANT}/${memberId}/${SEND_DTMF_ENDPOINT}`;
-
-  return {
-    method: HTTP_VERBS.POST,
-    uri,
-    body
-  };
-};
-
-MembersUtil.cancelPhoneInviteOptions = (invitee, locusUrl) => ({
-  invitee,
-  locusUrl
-});
-
-MembersUtil.generateCancelInviteRequestParams = (options) => {
-  const body = {
-    actionType: _REMOVE_,
-    invitees: [
-      {
-        address: options.invitee.phoneNumber
-      }
-    ]
-  };
-  const requestParams = {
-    method: HTTP_VERBS.PUT,
-    uri: options.locusUrl,
-    body
-  };
-
-  return requestParams;
-};
-
-export default MembersUtil;