@webex/plugin-meetings 3.0.0-beta.1 → 3.0.0-beta.104

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

@@ -0,0 +1,345 @@
+import lodash from 'lodash';
+import {
+  HTTP_VERBS,
+  _CONVERSATION_URL_,
+  WBXAPPAPI_SERVICE,
+  DEFAULT_MEETING_INFO_REQUEST_BODY,
+} from '../constants';
+import Metrics from '../metrics';
+import BEHAVIORAL_METRICS from '../metrics/constants';
+
+import MeetingInfoUtil from './utilv2';
+
+const PASSWORD_ERROR_DEFAULT_MESSAGE =
+  'Password required. Call fetchMeetingInfo() with password argument';
+const CAPTCHA_ERROR_DEFAULT_MESSAGE =
+  'Captcha required. Call fetchMeetingInfo() with captchaInfo argument';
+const ADHOC_MEETING_DEFAULT_ERROR =
+  'Failed starting the adhoc meeting, Please contact support team ';
+const CAPTCHA_ERROR_REQUIRES_PASSWORD_CODES = [423005, 423006];
+const POLICY_ERROR_CODES = [403049, 403104, 403103, 403048, 403102, 403101];
+
+/**
+ * Error to indicate that wbxappapi requires a password
+ */
+export class MeetingInfoV2PasswordError extends Error {
+  meetingInfo: any;
+  sdkMessage: any;
+  wbxAppApiCode: any;
+  body: any;
+
+  /**
+   *
+   * @constructor
+   * @param {Number} [wbxAppApiErrorCode]
+   * @param {Object} [meetingInfo]
+   * @param {String} [message]
+   */
+  constructor(
+    wbxAppApiErrorCode?: number,
+    meetingInfo?: object,
+    message: string = PASSWORD_ERROR_DEFAULT_MESSAGE
+  ) {
+    super(`${message}, code=${wbxAppApiErrorCode}`);
+    this.name = 'MeetingInfoV2PasswordError';
+    this.sdkMessage = message;
+    this.stack = new Error().stack;
+    this.wbxAppApiCode = wbxAppApiErrorCode;
+    this.meetingInfo = meetingInfo;
+  }
+}
+
+/**
+ * Error generating a adhoc space meeting
+ */
+export class MeetingInfoV2AdhocMeetingError extends Error {
+  sdkMessage: any;
+  wbxAppApiCode: any;
+  /**
+   *
+   * @constructor
+   * @param {Number} [wbxAppApiErrorCode]
+   * @param {String} [message]
+   */
+  constructor(wbxAppApiErrorCode?: number, message: string = ADHOC_MEETING_DEFAULT_ERROR) {
+    super(`${message}, code=${wbxAppApiErrorCode}`);
+    this.name = 'MeetingInfoV2AdhocMeetingError';
+    this.sdkMessage = message;
+    this.stack = new Error().stack;
+    this.wbxAppApiCode = wbxAppApiErrorCode;
+  }
+}
+
+/**
+ * Error preventing join because of a meeting policy
+ */
+export class MeetingInfoV2PolicyError extends Error {
+  meetingInfo: object;
+  sdkMessage: string;
+  wbxAppApiCode: number;
+  /**
+   *
+   * @constructor
+   * @param {Number} [wbxAppApiErrorCode]
+   * @param {Object} [meetingInfo]
+   * @param {String} [message]
+   */
+  constructor(wbxAppApiErrorCode?: number, meetingInfo?: object, message?: string) {
+    super(`${message}, code=${wbxAppApiErrorCode}`);
+    this.name = 'MeetingInfoV2AdhocMeetingError';
+    this.sdkMessage = message;
+    this.stack = new Error().stack;
+    this.wbxAppApiCode = wbxAppApiErrorCode;
+    this.meetingInfo = meetingInfo;
+  }
+}
+
+/**
+ * Error to indicate that preferred webex site not present to start adhoc meeting
+ */
+export class MeetingInfoV2CaptchaError extends Error {
+  captchaInfo: any;
+  isPasswordRequired: any;
+  sdkMessage: any;
+  wbxAppApiCode: any;
+  body: any;
+  /**
+   *
+   * @constructor
+   * @param {Number} [wbxAppApiErrorCode]
+   * @param {Object} [captchaInfo]
+   * @param {String} [message]
+   */
+  constructor(
+    wbxAppApiErrorCode?: number,
+    captchaInfo?: object,
+    message: string = CAPTCHA_ERROR_DEFAULT_MESSAGE
+  ) {
+    super(`${message}, code=${wbxAppApiErrorCode}`);
+    this.name = 'MeetingInfoV2PasswordError';
+    this.sdkMessage = message;
+    this.stack = new Error().stack;
+    this.wbxAppApiCode = wbxAppApiErrorCode;
+    this.isPasswordRequired = CAPTCHA_ERROR_REQUIRES_PASSWORD_CODES.includes(wbxAppApiErrorCode);
+    this.captchaInfo = captchaInfo;
+  }
+}
+
+/**
+ * @class MeetingInfo
+ */
+export default class MeetingInfoV2 {
+  webex: any;
+
+  /**
+   *
+   * @param {WebexSDK} webex
+   */
+  constructor(webex) {
+    this.webex = webex;
+  }
+
+  /**
+   * converts hydra id into conversation url and persons Id
+   * @param {String} destination one of many different types of destinations to look up info for
+   * @param {String} [type] to match up with the destination value
+   * @returns {Promise} destination and type
+   * @public
+   * @memberof MeetingInfo
+   */
+  fetchInfoOptions(destination: string, type: string = null) {
+    return MeetingInfoUtil.getDestinationType({
+      destination,
+      type,
+      webex: this.webex,
+    });
+  }
+
+  /**
+   * Creates adhoc space meetings for a space by fetching the conversation infomation
+   * @param {String} conversationUrl conversationUrl to start adhoc meeting on
+   * @returns {Promise} returns a meeting info object
+   * @public
+   * @memberof MeetingInfo
+   */
+  async createAdhocSpaceMeeting(conversationUrl: string) {
+    if (!this.webex.meetings.preferredWebexSite) {
+      throw Error('No preferred webex site found');
+    }
+    const getInvitees = (particpants = []) => {
+      const invitees = [];
+
+      if (particpants) {
+        particpants.forEach((participant) => {
+          invitees.push({
+            email: participant.emailAddress,
+            ciUserUuid: participant.entryUUID,
+          });
+        });
+      }
+
+      return invitees;
+    };
+
+    return this.webex.internal.conversation
+      .get({url: conversationUrl}, {includeParticipants: true, disableTransform: true})
+      .then((conversation) => {
+        const body = {
+          title: conversation.displayName,
+          spaceUrl: conversation.url,
+          keyUrl: conversation.encryptionKeyUrl,
+          kroUrl: conversation.kmsResourceObjectUrl,
+          invitees: getInvitees(conversation.participants?.items),
+        };
+
+        const uri = this.webex.meetings.preferredWebexSite
+          ? `https://${this.webex.meetings.preferredWebexSite}/wbxappapi/v2/meetings/spaceInstant`
+          : '';
+
+        Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.ADHOC_MEETING_SUCCESS);
+
+        return this.webex.request({
+          method: HTTP_VERBS.POST,
+          uri,
+          body,
+        });
+      })
+      .catch((err) => {
+        Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.ADHOC_MEETING_FAILURE, {
+          reason: err.message,
+          stack: err.stack,
+        });
+        throw new MeetingInfoV2AdhocMeetingError(err.body?.code, err.body?.message);
+      });
+  }
+
+  /**
+   * Fetches meeting info from the server
+   * @param {String} destination one of many different types of destinations to look up info for
+   * @param {String} [type] to match up with the destination value
+   * @param {String} password
+   * @param {Object} captchaInfo
+   * @param {String} captchaInfo.code
+   * @param {String} captchaInfo.id
+   * @param {String} installedOrgID
+   * @param {String} locusId
+   * @param {Object} extraParams
+   * @returns {Promise} returns a meeting info object
+   * @public
+   * @memberof MeetingInfo
+   */
+  async fetchMeetingInfo(
+    destination: string,
+    type: string = null,
+    password: string = null,
+    captchaInfo: {
+      code: string;
+      id: string;
+    } = null,
+    installedOrgID = null,
+    locusId = null,
+    extraParams = {}
+  ) {
+    const destinationType = await MeetingInfoUtil.getDestinationType({
+      destination,
+      type,
+      webex: this.webex,
+    });
+
+    if (
+      destinationType.type === _CONVERSATION_URL_ &&
+      this.webex.config.meetings.experimental.enableAdhocMeetings &&
+      this.webex.meetings.preferredWebexSite
+    ) {
+      return this.createAdhocSpaceMeeting(destinationType.destination);
+    }
+
+    const body = await MeetingInfoUtil.getRequestBody({
+      ...destinationType,
+      password,
+      captchaInfo,
+      installedOrgID,
+      locusId,
+      extraParams,
+    });
+
+    // If the body only contains the default properties, we don't have enough to
+    // fetch the meeting info so don't bother trying.
+    if (
+      !lodash.difference(Object.keys(body), Object.keys(DEFAULT_MEETING_INFO_REQUEST_BODY)).length
+    ) {
+      const err = new Error('Not enough information to fetch meeting info');
+      Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.FETCH_MEETING_INFO_V1_FAILURE, {
+        reason: err.message,
+        destinationType: destinationType?.type,
+        webExMeetingId: destinationType?.info?.webExMeetingId,
+        sipUri: destinationType?.info?.sipUri,
+      });
+
+      throw err;
+    }
+
+    const options: any = {
+      method: HTTP_VERBS.POST,
+      body,
+    };
+
+    const directURI = await MeetingInfoUtil.getDirectMeetingInfoURI(destinationType);
+
+    if (directURI) {
+      options.uri = directURI;
+    } else {
+      options.service = WBXAPPAPI_SERVICE;
+      options.resource = 'meetingInfo';
+    }
+
+    return this.webex
+      .request(options)
+      .then((response) => {
+        Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.FETCH_MEETING_INFO_V1_SUCCESS);
+
+        return response;
+      })
+      .catch((err) => {
+        if (err?.statusCode === 403) {
+          if (POLICY_ERROR_CODES.includes(err.body?.code)) {
+            Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.MEETING_INFO_POLICY_ERROR, {
+              code: err.body?.code,
+            });
+
+            throw new MeetingInfoV2PolicyError(
+              err.body?.code,
+              err.body?.data?.meetingInfo,
+              err.body?.message
+            );
+          }
+
+          Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.VERIFY_PASSWORD_ERROR, {
+            reason: err.message,
+            stack: err.stack,
+          });
+
+          throw new MeetingInfoV2PasswordError(err.body?.code, err.body?.data?.meetingInfo);
+        }
+        if (err?.statusCode === 423) {
+          Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.VERIFY_CAPTCHA_ERROR, {
+            reason: err.message,
+            stack: err.stack,
+          });
+
+          throw new MeetingInfoV2CaptchaError(err.body?.code, {
+            captchaId: err.body.captchaID,
+            verificationImageURL: err.body.verificationImageURL,
+            verificationAudioURL: err.body.verificationAudioURL,
+            refreshURL: err.body.refreshURL,
+          });
+        }
+
+        Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.FETCH_MEETING_INFO_V1_FAILURE, {
+          reason: err.message,
+          stack: err.stack,
+        });
+        throw err;
+      });
+  }
+}

package/src/meeting-info/{request.js → request.ts}

@@ -2,15 +2,18 @@ import {API} from '../constants';
 import ParameterError from '../common/errors/parameter';
 
 import MeetingInfoUtil from './util';
+
 /**
  * @class MeetingInfoRequest
  */
 export default class MeetingInfoRequest {
+  webex: any;
+
   /**
    * Meeting Info Request Constructor
    * @param {WebexSDK} webex
    */
-  constructor(webex) {
+  constructor(webex: any) {
     this.webex = webex;
   }
 
@@ -24,12 +27,19 @@ export default class MeetingInfoRequest {
    * @throws {Error} if the options are not valid and complete
    * @memberof MeetingInfoRequest
    */
-  fetchMeetingInfo(options) {
+  fetchMeetingInfo(options: any) {
     if (!options || !options.type || !options.destination) {
-      throw new ParameterError('MeetingInfo should be fetched with a type and destination specified, see list of valid types and their corresponding values in constants');
+      throw new ParameterError(
+        'MeetingInfo should be fetched with a type and destination specified, see list of valid types and their corresponding values in constants'
+      );
     }
     const resourceUrl = MeetingInfoUtil.getResourceUrl(options.type, options.destination);
-    const requestParams = MeetingInfoUtil.getRequestParams(resourceUrl, options.type, options.destination, API.LOCUS);
+    const requestParams = MeetingInfoUtil.getRequestParams(
+      resourceUrl,
+      options.type,
+      options.destination,
+      API.LOCUS
+    );
 
     return this.webex.request(requestParams);
   }

package/src/meeting-info/{util.js → util.ts}

@@ -2,7 +2,8 @@ import url from 'url';
 
 import btoa from 'btoa';
 import {
-  deconstructHydraId
+  // @ts-ignore
+  deconstructHydraId,
 } from '@webex/common';
 
 import ParameterError from '../common/errors/parameter';
@@ -30,10 +31,10 @@ import {
   MEET,
   MEET_M,
   HTTPS_PROTOCOL,
-  UUID_REG
+  UUID_REG,
 } from '../constants';
 
-const MeetingInfoUtil = {};
+const MeetingInfoUtil: any = {};
 
 MeetingInfoUtil.extractDestination = (destination, type) => {
   let dest = destination;
@@ -61,9 +62,10 @@ MeetingInfoUtil.getParsedUrl = (link) => {
     }
 
     return parsedUrl;
-  }
-  catch (error) {
-    LoggerProxy.logger.warn(`Meeting-info:util#getParsedUrl --> unable to parse the URL, error: ${error}`);
+  } catch (error) {
+    LoggerProxy.logger.warn(
+      `Meeting-info:util#getParsedUrl --> unable to parse the URL, error: ${error}`
+    );
 
     return null;
   }
@@ -74,10 +76,14 @@ MeetingInfoUtil.getParsedUrl = (link) => {
  * @param {String} value  string to parse and see if it matches a meeting link
  * @returns {Boolean}
  */
-MeetingInfoUtil.isMeetingLink = (value) => {
+MeetingInfoUtil.isMeetingLink = (value: string) => {
   const parsedUrl = MeetingInfoUtil.getParsedUrl(value);
   const hostNameBool = parsedUrl.hostname && parsedUrl.hostname.includes(WEBEX_DOT_COM);
-  const pathNameBool = parsedUrl.pathname && (parsedUrl.pathname.includes(`/${MEET}`) || parsedUrl.pathname.includes(`/${MEET_M}`) || parsedUrl.pathname.includes(`/${JOIN}`));
+  const pathNameBool =
+    parsedUrl.pathname &&
+    (parsedUrl.pathname.includes(`/${MEET}`) ||
+      parsedUrl.pathname.includes(`/${MEET_M}`) ||
+      parsedUrl.pathname.includes(`/${JOIN}`));
 
   return hostNameBool && pathNameBool;
 };
@@ -122,7 +128,6 @@ MeetingInfoUtil.convertLinkToSip = (value) => {
   return `${user}@${company}.${WEBEX_DOT_COM}`;
 };
 
-
 MeetingInfoUtil.isSipUri = (sipString) => {
   // TODO: lets remove regex from this equation and user URI matchers and such
   // have not found a great sip uri parser library as of now
@@ -154,15 +159,21 @@ MeetingInfoUtil.getHydraId = (destination) => {
   return {};
 };
 
-MeetingInfoUtil.getSipUriFromHydraPersonId = (destination, webex) => webex.people.get(destination).then((res) => {
-  if (res.emails && res.emails.length) {
-    return res.emails[0];
-  }
-  throw new ParameterError('Hydra Id Lookup was an invalid hydra person id.');
-}).catch((err) => {
-  LoggerProxy.logger.error(`Meeting-info:util#MeetingInfoUtil.getSipUriFromHydraPersonId --> getSipUriFromHydraPersonId ${err} `);
-  throw err;
-});
+MeetingInfoUtil.getSipUriFromHydraPersonId = (destination, webex) =>
+  webex.people
+    .get(destination)
+    .then((res) => {
+      if (res.emails && res.emails.length) {
+        return res.emails[0];
+      }
+      throw new ParameterError('Hydra Id Lookup was an invalid hydra person id.');
+    })
+    .catch((err) => {
+      LoggerProxy.logger.error(
+        `Meeting-info:util#MeetingInfoUtil.getSipUriFromHydraPersonId --> getSipUriFromHydraPersonId ${err} `
+      );
+      throw err;
+    });
 
 MeetingInfoUtil.generateOptions = async (from) => {
   const {destination, type, webex} = from;
@@ -170,31 +181,29 @@ MeetingInfoUtil.generateOptions = async (from) => {
   if (type) {
     return {
       destination,
-      type
+      type,
     };
   }
-  const options = {};
+  const options: any = {};
   const hydraId = MeetingInfoUtil.getHydraId(destination);
 
   if (MeetingInfoUtil.isMeetingLink(destination)) {
-    LoggerProxy.logger.warn('Meeting-info:util#generateOptions --> WARN, use of Meeting Link is deprecated, please use a SIP URI instead');
+    LoggerProxy.logger.warn(
+      'Meeting-info:util#generateOptions --> WARN, use of Meeting Link is deprecated, please use a SIP URI instead'
+    );
 
     options.type = _MEETING_LINK_;
     options.destination = destination;
-  }
-  else if (MeetingInfoUtil.isSipUri(destination)) {
+  } else if (MeetingInfoUtil.isSipUri(destination)) {
     options.type = _SIP_URI_;
     options.destination = destination;
-  }
-  else if (MeetingInfoUtil.isPhoneNumber(destination)) {
+  } else if (MeetingInfoUtil.isPhoneNumber(destination)) {
     options.type = _SIP_URI_;
     options.destination = destination;
-  }
-  else if (MeetingInfoUtil.isConversationUrl(destination, webex)) {
+  } else if (MeetingInfoUtil.isConversationUrl(destination, webex)) {
     options.type = _CONVERSATION_URL_;
     options.destination = destination;
-  }
-  else if (hydraId.people) {
+  } else if (hydraId.people) {
     options.type = _SIP_URI_;
 
     return MeetingInfoUtil.getSipUriFromHydraPersonId(hydraId.destination, webex).then((res) => {
@@ -207,26 +216,25 @@ MeetingInfoUtil.generateOptions = async (from) => {
 
       return Promise.resolve(options);
     });
-  }
-  else if (hydraId.room) {
+  } else if (hydraId.room) {
     options.type = _CONVERSATION_URL_;
     try {
       await webex.internal.services.waitForCatalog('postauth');
 
       const conversationUrl = webex.internal.conversation.getUrlFromClusterId({
         cluster: hydraId.cluster,
-        id: hydraId.destination
+        id: hydraId.destination,
       });
 
       options.destination = conversationUrl;
-    }
-    catch (e) {
+    } catch (e) {
       LoggerProxy.logger.error(`Meeting-info:util#generateOptions --> ${e}`);
-      throw (e);
+      throw e;
     }
-  }
-  else {
-    throw new ParameterError('MeetingInfo is fetched with meeting link, sip uri, phone number, hydra room id, hydra people id, or a conversation url.');
+  } else {
+    throw new ParameterError(
+      'MeetingInfo is fetched with meeting link, sip uri, phone number, hydra room id, hydra people id, or a conversation url.'
+    );
   }
 
   return Promise.resolve(options);
@@ -238,7 +246,7 @@ MeetingInfoUtil.generateOptions = async (from) => {
  * @param {Object} value ?? value.value
  * @returns {Object} returns an object with {resource, method}
  */
-MeetingInfoUtil.getResourceUrl = (type, value) => {
+MeetingInfoUtil.getResourceUrl = (type: string, value: any) => {
   let resource = `/${LOCI}/${MEETINGINFO}`;
   let method = HTTP_VERBS.GET;
   let uri = null;
@@ -247,7 +255,9 @@ MeetingInfoUtil.getResourceUrl = (type, value) => {
     case _SIP_URI_:
     case _PERSONAL_ROOM_:
     case _MEETING_ID_:
-      resource = `/${LOCI}/${MEETINGINFO}/${encodeURIComponent(value)}?${TYPE}=${type}&${USE_URI_LOOKUP_FALSE}`;
+      resource = `/${LOCI}/${MEETINGINFO}/${encodeURIComponent(
+        value
+      )}?${TYPE}=${type}&${USE_URI_LOOKUP_FALSE}`;
       break;
     case _CONVERSATION_URL_:
       method = HTTP_VERBS.PUT;
@@ -257,7 +267,9 @@ MeetingInfoUtil.getResourceUrl = (type, value) => {
       method = HTTP_VERBS.PUT;
       break;
     case _MEETING_LINK_:
-      resource = `$/${LOCI}/${MEETINGINFO}/${btoa(value)}?${TYPE}=${_MEETING_LINK_}&${USE_URI_LOOKUP_FALSE}`;
+      resource = `$/${LOCI}/${MEETINGINFO}/${btoa(
+        value
+      )}?${TYPE}=${_MEETING_LINK_}&${USE_URI_LOOKUP_FALSE}`;
       break;
     default:
   }
@@ -265,34 +277,31 @@ MeetingInfoUtil.getResourceUrl = (type, value) => {
   return {
     uri,
     resource,
-    method
+    method,
   };
 };
 
 MeetingInfoUtil.getRequestParams = (resourceOptions, type, value, api) => {
-  let requestParams = {
+  let requestParams: any = {
     method: resourceOptions.method,
     api,
-    resource: resourceOptions.resource
+    resource: resourceOptions.resource,
   };
 
   if (resourceOptions.method === HTTP_VERBS.GET) {
     // for handling URL redirections
     requestParams.resource = requestParams.resource.concat(`&${ALTERNATE_REDIRECT_TRUE}`);
-  }
-  else
-  if (type !== _LOCUS_ID_) {
+  } else if (type !== _LOCUS_ID_) {
     // locus id check is a PUT not sure why
     requestParams.resource = requestParams.resource.concat(`?${ALTERNATE_REDIRECT_TRUE}`);
     requestParams.body = {
       value,
-      lookupType: type
+      lookupType: type,
     };
-  }
-  else if (type === _LOCUS_ID_) {
+  } else if (type === _LOCUS_ID_) {
     requestParams = {
       method: resourceOptions.method,
-      uri: resourceOptions.uri
+      uri: resourceOptions.uri,
     };
   }