@webex/plugin-meetings 3.0.0-beta.4 → 3.0.0-beta.400

package/src/meeting/request.js

@@ -1,684 +0,0 @@
-import uuid from 'uuid';
-import {debounce} from 'lodash';
-import {StatelessWebexPlugin} from '@webex/webex-core';
-import {deviceType} from '@webex/common';
-
-import LoggerProxy from '../common/logs/logger-proxy';
-import {
-  ALERT,
-  ALTERNATE_REDIRECT_TRUE,
-  CALL,
-  CONTROLS,
-  DECLINE,
-  END,
-  FLOOR_ACTION,
-  HTTP_VERBS,
-  LEAVE,
-  LOCI,
-  LOCUS,
-  MEDIA,
-  PARTICIPANT,
-  PROVISIONAL_TYPE_DIAL_IN,
-  PROVISIONAL_TYPE_DIAL_OUT,
-  SEND_DTMF_ENDPOINT,
-  _SLIDES_
-} from '../constants';
-
-/**
- * @class MeetingRequest
- */
-export default class MeetingRequest extends StatelessWebexPlugin {
-  constructor(attrs, options) {
-    super(attrs, options);
-    this.changeVideoLayoutDebounced = debounce(this.changeVideoLayout, 2000, {leading: true, trailing: true});
-  }
-
-  /**
-   * Make a network request to join a meeting
-   * @param {Object} options
-   * @param {String} options.sipUri
-   * @param {String} options.deviceUrl
-   * @param {String} options.locusUrl
-   * @param {String} options.resourceId,
-   * @param {String} options.correlationId
-   * @param {boolean} options.ensureConversation
-   * @param {boolean} options.moderator
-   * @param {boolean} options.pin
-   * @param {boolean} options.moveToResource
-   * @param {Object} options.roapMessage
-   * @returns {Promise}
-   */
-  async joinMeeting(options) {
-    const {
-      asResourceOccupant,
-      inviteeAddress,
-      meetingNumber,
-      permissionToken,
-      deviceUrl,
-      locusUrl,
-      resourceId,
-      correlationId,
-      ensureConversation,
-      moderator,
-      pin,
-      moveToResource,
-      roapMessage,
-      preferTranscoding
-    } = options;
-
-    LoggerProxy.logger.info(
-      'Meeting:request#joinMeeting --> Joining a meeting',
-      correlationId
-    );
-
-    let url = '';
-
-    const body = {
-      asResourceOccupant,
-      device: {
-        url: deviceUrl,
-        deviceType: this.config.meetings.deviceType
-      },
-      usingResource: resourceId || null,
-      moveMediaToResource: resourceId && moveToResource || false,
-      correlationId,
-      respOnlySdp: true,
-      allowMultiDevice: true,
-      ensureConversation: ensureConversation || false,
-      supportsNativeLobby: 1,
-      clientMediaPreferences: {
-        preferTranscoding: preferTranscoding ?? true
-      }
-    };
-
-    if (this.webex.meetings.clientRegion) {
-      body.device.countryCode = this.webex.meetings.clientRegion.countryCode;
-      body.device.regionCode = this.webex.meetings.clientRegion.regionCode;
-    }
-
-    if (moderator !== undefined) {
-      body.moderator = moderator;
-    }
-
-    if (permissionToken) {
-      body.permissionToken = permissionToken;
-    }
-
-    if (pin !== undefined) {
-      body.pin = pin;
-    }
-
-    if (locusUrl) {
-      url = `${locusUrl}/${PARTICIPANT}`;
-    }
-    else if (inviteeAddress || meetingNumber) {
-      try {
-        await this.webex.internal.services.waitForCatalog('postauth');
-        url = `${this.webex.internal.services.get('locus')}/${LOCI}/${CALL}`;
-        body.invitee = {
-          address: inviteeAddress || `wbxmn:${meetingNumber}`
-        };
-      }
-      catch (e) {
-        LoggerProxy.logger.error(`Meeting:request#joinMeeting Error Joining ${inviteeAddress || meetingNumber} --> ${e}`);
-        throw (e);
-      }
-    }
-
-
-    // TODO: -- this will be resolved in SDK request
-    url = url.concat(`?${ALTERNATE_REDIRECT_TRUE}`);
-
-    if (resourceId === inviteeAddress) {
-      body.callPreferences = {
-        requestedMedia: [_SLIDES_]
-      };
-    }
-
-    if (roapMessage) {
-      body.localMedias = roapMessage.localMedias;
-    }
-
-    return this.request({
-      method: HTTP_VERBS.POST,
-      uri: url,
-      body
-    });
-  }
-
-  /**
-   * Send a request to refresh the captcha
-   * @param {Object} options
-   * @param {String} options.captchaRefreshUrl
-   * @param {String} options.captchaId
-   * @returns {Promise}
-   * @private
-   */
-  refreshCaptcha({
-    captchaRefreshUrl,
-    captchaId
-  }) {
-    const body = {
-      captchaId
-    };
-
-    return this.request({
-      method: HTTP_VERBS.POST,
-      uri: captchaRefreshUrl,
-      body
-    }).catch((err) => {
-      LoggerProxy.logger.error(`Meeting:request#refreshCaptcha --> Error: ${err}`);
-
-      throw err;
-    });
-  }
-
-  /**
-   * 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.dialInUrl identifier for the to-be provisioned device
-   * @param {String} options.clientUrl identifier for the web device
-   * @returns {Promise}
-   * @private
-   */
-  dialIn({
-    locusUrl,
-    dialInUrl,
-    clientUrl,
-    correlationId
-  }) {
-    LoggerProxy.logger.info(
-      'Meeting:request#dialIn --> Provisioning a dial in device',
-      correlationId
-    );
-    const uri = `${locusUrl}/${PARTICIPANT}`;
-
-    const body = {
-      device: {
-        deviceType: deviceType.PROVISIONAL,
-        provisionalType: PROVISIONAL_TYPE_DIAL_IN,
-        url: dialInUrl,
-        clientUrl
-      },
-      correlationId
-    };
-
-    return this.request({
-      method: HTTP_VERBS.POST,
-      uri,
-      body
-    }).catch((err) => {
-      LoggerProxy.logger.error(`Meeting:request#dialIn --> Error provisioning a dial in device, error ${err}`);
-
-      throw err;
-    });
-  }
-
-  /**
-   * 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.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({
-    locusUrl,
-    dialOutUrl,
-    phoneNumber,
-    clientUrl,
-    correlationId
-  }) {
-    LoggerProxy.logger.info(
-      'Meeting:request#dialOut --> Provisioning a dial out device',
-      correlationId
-    );
-    const uri = `${locusUrl}/${PARTICIPANT}`;
-
-    const body = {
-      device: {
-        deviceType: deviceType.PROVISIONAL,
-        provisionalType: PROVISIONAL_TYPE_DIAL_OUT,
-        url: dialOutUrl,
-        dialoutAddress: phoneNumber,
-        clientUrl
-      },
-      correlationId
-    };
-
-    return this.request({
-      method: HTTP_VERBS.POST,
-      uri,
-      body
-    }).catch((err) => {
-      LoggerProxy.logger.error(`Meeting:request#dialOut --> Error provisioning a dial out device, error ${err}`);
-
-      throw err;
-    });
-  }
-
-  /**
-   * Syns the missed delta event
-   * @param {Object} options
-   * @param {boolen} 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) {
-    /* eslint-disable no-else-return */
-    const {desync} = options;
-    let {syncUrl} = options;
-
-    /* istanbul ignore else */
-    if (desync) {
-      // check for existing URL parameters
-      syncUrl = syncUrl.concat(syncUrl.split('?')[1] ? '&' : '?').concat(`${LOCUS.SYNCDEBUG}=${desync}`);
-    }
-
-    return this.request({
-      method: HTTP_VERBS.GET,
-      uri: syncUrl
-    }) // TODO: Handle if delta sync failed . Get the full locus object
-      .catch((err) => {
-        LoggerProxy.logger.error(`Meeting:request#syncMeeting --> Error syncing meeting, error ${err}`);
-
-        return err;
-      });
-  }
-
-  /**
-   * Request to get the complete locus object
-   * @param {Object} options
-   * @param {boolen} 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) {
-    let {locusUrl} = options;
-    const {desync} = options;
-
-    if (locusUrl) {
-      if (desync) {
-        locusUrl += `?${LOCUS.SYNCDEBUG}=${desync}`;
-      }
-
-      return this.request({
-        method: HTTP_VERBS.GET,
-        uri: locusUrl
-      }).catch((err) => {
-        LoggerProxy.logger.error(`Meeting:request#getFullLocus --> Error getting full locus, error ${err}`);
-
-        return err;
-      });
-    }
-
-    return Promise.reject();
-  }
-
-  /**
-   * Make a network request to make a provisioned phone leave the meeting
-   * @param {Object} options
-   * @param {String} options.locusUrl
-   * @param {String} options.phoneUrl
-   * @param {String} options.correlationId
-   * @param {String} options.selfId
-   * @returns {Promise}
-   * @private
-   */
-  disconnectPhoneAudio({
-    locusUrl,
-    phoneUrl,
-    correlationId,
-    selfId
-  }) {
-    LoggerProxy.logger.info(
-      `Meeting:request#disconnectPhoneAudio --> request phone ${phoneUrl} to leave`,
-      correlationId
-    );
-    const uri = `${locusUrl}/${PARTICIPANT}/${selfId}/${LEAVE}`;
-
-    const body = {
-      device: {
-        deviceType: deviceType.PROVISIONAL,
-        url: phoneUrl
-      },
-      correlationId
-    };
-
-    return this.request({
-      method: HTTP_VERBS.PUT,
-      uri,
-      body
-    }).catch((err) => {
-      LoggerProxy.logger.error(
-        `Meeting:request#disconnectPhoneAudio --> Error when requesting phone ${phoneUrl} to leave, error ${err}`
-      );
-
-      throw err;
-    });
-  }
-
-  /**
-   * Make a network request to leave a meeting
-   * @param {Object} options
-   * @param {Url} options.locusUrl
-   * @param {String} options.selfId
-   * @param {Url} options.deviceUrl
-   * @param {String} options.resourceId,
-   * @param {String} options.correlationId
-   * @returns {Promise}
-   */
-  leaveMeeting({
-    locusUrl,
-    selfId,
-    deviceUrl: url,
-    resourceId,
-    correlationId
-  }) {
-    LoggerProxy.logger.info(
-      'Meeting:request#leaveMeeting --> Leaving a meeting',
-      correlationId
-    );
-
-    const uri = `${locusUrl}/${PARTICIPANT}/${selfId}/${LEAVE}`;
-    const body = {
-      device: {
-        deviceType: this.config.meetings.deviceType,
-        url
-      },
-      usingResource: resourceId || null,
-      correlationId
-    };
-
-    return this.request({
-      method: HTTP_VERBS.PUT,
-      uri,
-      body
-    });
-  }
-
-  /**
-   * Make a network request to acknowledge a meeting
-   * @param {Object} options
-   * @param {String} options.locusUrl
-   * @param {String} options.deviceUrl
-   * @param {String} options.correlationId
-   * @returns {Promise}
-   */
-  acknowledgeMeeting(options) {
-    const uri = `${options.locusUrl}/${PARTICIPANT}/${ALERT}`;
-    const body = {
-      device: {
-        deviceType: this.config.meetings.deviceType,
-        url: options.deviceUrl
-      },
-      correlationId: options.correlationId
-    };
-
-    return this.request({
-      method: HTTP_VERBS.PUT,
-      uri,
-      body
-    });
-  }
-
-  /**
-   * 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) {
-    const uri = `${options.locusUrl}/${CONTROLS}`;
-    const body = {
-      record: {
-        recording: options.recording,
-        paused: options.paused
-      }
-    };
-
-    return this.request({
-      method: HTTP_VERBS.PATCH,
-      uri,
-      body
-    });
-  }
-
-  lockMeeting(options) {
-    const uri = `${options.locusUrl}/${CONTROLS}`;
-    const body = {
-      lock: {
-        locked: options.lock
-      }
-    };
-
-    return this.request({
-      method: HTTP_VERBS.PATCH,
-      uri,
-      body
-    });
-  }
-
-  /**
-   * Make a network request to decline a meeting
-   * @param {Object} options
-   * @param {String} options.locusUrl
-   * @param {String} options.deviceUrl
-   * @param {String} options.reason
-   * @returns {Promise}
-   */
-  declineMeeting(options) {
-    const uri = `${options.locusUrl}/${PARTICIPANT}/${DECLINE}`;
-    const body = {
-      device: {
-        deviceType: this.config.meetings.deviceType,
-        url: options.deviceUrl
-      },
-      ...(options.reason && {reason: options.reason})
-    };
-
-    return this.request({
-      method: HTTP_VERBS.PUT,
-      uri,
-      body
-    });
-  }
-
-  /**
-   * Toggle remote audio and/or video
-   * @param {Object} options options for toggling
-   * @param {String} options.selfId Locus self id??
-   * @param {String} options.locusUrl Locus url
-   * @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) {
-    const uri = `${options.locusUrl}/${PARTICIPANT}/${options.selfId}/${MEDIA}`;
-    const body = {
-      device: {
-        deviceType: this.config.meetings.deviceType,
-        url: options.deviceUrl
-      },
-      usingResource: options.resourceId || null,
-      correlationId: options.correlationId,
-      respOnlySdp: true,
-      localMedias: options.localMedias,
-      clientMediaPreferences: {
-        preferTranscoding: options.preferTranscoding ?? true
-      }
-    };
-
-    return this.request({
-      method: HTTP_VERBS.PUT,
-      uri,
-      body
-    });
-  }
-
-  /**
-   * change the content floor grant
-   * @param {Object} options options for floor grant
-   * @param {String} options.disposition floor action (granted/released)
-   * @param {String} options.personUrl personUrl who is requesting floor
-   * @param {String} options.deviceUrl Url of a device
-   * @param {String} options.resourceId Populated if you are paired to a device
-   * @param {String} options.uri floor grant uri
-   * @returns {Promise}
-   */
-  changeMeetingFloor(options) {
-    let floorReq = {disposition: options.disposition};
-
-    /* istanbul ignore else */
-    if (options.disposition === FLOOR_ACTION.GRANTED) {
-      floorReq = {
-        beneficiary: {
-          url: options.personUrl,
-          devices: [
-            {
-              deviceType: this.config.meetings.deviceType,
-              url: options.deviceUrl
-            }
-          ]
-        },
-        disposition: options.disposition,
-        requester: {
-          url: options.personUrl
-        }
-      };
-    }
-
-    const body = {
-      floor: floorReq,
-      resourceUrl: options.resourceUrl
-    };
-
-    if (options?.resourceToken) {
-      body.resourceToken = options?.resourceToken;
-    }
-
-    return this.request({
-      uri: options.uri,
-      method: HTTP_VERBS.PUT,
-      body
-    });
-  }
-
-  /**
-   * Sends a request to the DTMF endpoint to send tones
-   * @param {Object} options
-   * @param {String} options.locusUrl
-   * @param {String} options.deviceUrl
-   * @param {String} options.tones a string of one or more DTMF tones to send
-   * @returns {Promise}
-   */
-  sendDTMF({locusUrl, deviceUrl, tones}) {
-    return this.request({
-      method: HTTP_VERBS.POST,
-      uri: `${locusUrl}/${SEND_DTMF_ENDPOINT}`,
-      body: {
-        deviceUrl,
-        dtmf: {
-          correlationId: uuid.v4(),
-          tones
-        }
-      }
-    });
-  }
-
-  /**
-   * Sends a request to the controls endpoint to set the video layout
-   * @param {Object} options
-   * @param {String} options.locusUrl
-   * @param {String} options.deviceUrl
-   * @param {String} options.layoutType a layout type that should be available in meeting constants {@link #layout_types}
-   * @param {Object} options.main preferred dimensions for the remote main video stream
-   * @param {Number} options.main.width preferred width of main video stream
-   * @param {Number} options.main.height preferred height of main video stream
-   * @param {Object} options.content preferred dimensions for the remote content share stream
-   * @param {Number} options.content.width preferred width of content share stream
-   * @param {Number} options.content.height preferred height of content share stream
-   * @returns {Promise}
-   */
-  changeVideoLayout({
-    locusUrl,
-    deviceUrl,
-    layoutType,
-    main,
-    content
-  }) {
-    // send main/content renderInfo only if both width and height are specified
-    if (main && (!main.width || !main.height)) {
-      return Promise.reject(new Error(`Both width and height must be specified. One of them is missing for main: ${JSON.stringify(main)}`));
-    }
-
-    if (content && (!content.width || !content.height)) {
-      return Promise.reject(new Error(`Both width and height must be specified. One of them is missing for content: ${JSON.stringify(content)}`));
-    }
-
-    const renderInfoMain = (main) ? {width: main.width, height: main.height} : undefined;
-    const renderInfoContent = (content) ? {width: content.width, height: content.height} : undefined;
-
-    const layoutParams = (renderInfoMain || renderInfoContent) ?
-      {
-        renderInfo:
-        {
-          main: renderInfoMain,
-          content: renderInfoContent
-        }
-      } : undefined;
-
-    return this.request({
-      method: HTTP_VERBS.PUT,
-      uri: `${locusUrl}/${CONTROLS}`,
-      body: {
-        layout: {
-          deviceUrl,
-          type: layoutType,
-          layoutParams
-        }
-      }
-    });
-  }
-
-  /**
-   * Make a network request to end meeting for all
-   * @param {Object} options
-   * @param {Url} options.locusUrl
-   * @returns {Promise}
-   */
-  endMeetingForAll({
-    locusUrl,
-  }) {
-    const uri = `${locusUrl}/${END}`;
-
-    return this.request({
-      method: HTTP_VERBS.POST,
-      uri
-    });
-  }
-
-  /**
-   * Send a locus keepAlive (used in lobby)
-   * @param {Object} options
-   * @param {Url} options.keepAliveUrl
-   * @returns {Promise}
-   */
-  keepAlive({
-    keepAliveUrl,
-  }) {
-    return this.request({
-      method: HTTP_VERBS.GET,
-      uri: keepAliveUrl
-    });
-  }
-}