@webex/plugin-meetings 2.59.1 → 2.59.3-next.1

package/src/meeting-info/utilv2.ts

@@ -1,324 +1,324 @@
-import url from 'url';
-
-// @ts-ignore
-import {deconstructHydraId} from '@webex/common';
-
-import {
-  _SIP_URI_,
-  _PERSONAL_ROOM_,
-  _MEETING_ID_,
-  _CONVERSATION_URL_,
-  _LOCUS_ID_,
-  _MEETING_LINK_,
-  _PEOPLE_,
-  _ROOM_,
-  _MEETING_UUID_,
-  DIALER_REGEX,
-  WEBEX_DOT_COM,
-  CONVERSATION_SERVICE,
-  JOIN,
-  MEET,
-  MEET_M,
-  HTTPS_PROTOCOL,
-  UUID_REG,
-  VALID_EMAIL_ADDRESS,
-} from '../constants';
-import ParameterError from '../common/errors/parameter';
-import LoggerProxy from '../common/logs/logger-proxy';
-
-const MeetingInfoUtil: any = {};
-
-MeetingInfoUtil.getParsedUrl = (link) => {
-  try {
-    let parsedUrl = url.parse(link);
-
-    if (!parsedUrl) {
-      return false;
-    }
-    // hack for links such as <company>.webex.com/meet/<user> without a protocol
-    if (!parsedUrl.protocol) {
-      parsedUrl = url.parse(`${HTTPS_PROTOCOL}${link}`);
-    }
-
-    return parsedUrl;
-  } catch (error) {
-    LoggerProxy.logger.warn(
-      `Meeting-info:util#getParsedUrl --> unable to parse the URL, error: ${error}`
-    );
-
-    return null;
-  }
-};
-
-/**
- * Helper function to check if a string matches a known meeting link pattern
- * @param {String} value  string to parse and see if it matches a meeting link
- * @returns {Boolean}
- */
-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}`));
-
-  return hostNameBool && pathNameBool;
-};
-
-MeetingInfoUtil.isConversationUrl = (value, webex) => {
-  const clusterId = webex.internal.services.getClusterId(value);
-
-  if (clusterId) {
-    return clusterId.endsWith(CONVERSATION_SERVICE);
-  }
-
-  return false;
-};
-
-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
-  const sipUri = DIALER_REGEX.SIP_ADDRESS.exec(sipString);
-
-  return sipUri;
-};
-
-MeetingInfoUtil.isPhoneNumber = (phoneNumber) => {
-  const isValidNumber = DIALER_REGEX.PHONE_NUMBER.test(phoneNumber);
-
-  return isValidNumber;
-};
-
-MeetingInfoUtil.getHydraId = (destination) => {
-  const {type, id, cluster} = deconstructHydraId(destination);
-
-  if (id && UUID_REG.test(id)) {
-    if (type === _ROOM_) {
-      return {room: true, destination: id, cluster};
-    }
-    if (type === _PEOPLE_) {
-      return {people: true, destination: id, cluster};
-    }
-
-    return {};
-  }
-
-  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.getDestinationType = async (from) => {
-  const {type, webex} = from;
-  let {destination} = from;
-
-  if (type === _PERSONAL_ROOM_) {
-    // this case checks if your type is personal room
-    if (!destination) {
-      // if we are not getting anything in desination we fetch org and user ids from webex instance
-      destination = {
-        userId: webex.internal.device.userId,
-        orgId: webex.internal.device.orgId,
-      };
-    } else {
-      const options = VALID_EMAIL_ADDRESS.test(destination)
-        ? {email: destination}
-        : {id: destination}; // we are assuming userId as default
-      const res = await webex.people.list(options);
-
-      let {orgId, id: userId} = res.items[0];
-
-      userId = deconstructHydraId(userId).id;
-      orgId = deconstructHydraId(orgId).id;
-      destination = {userId, orgId};
-    }
-  }
-  if (type) {
-    return {
-      destination,
-      type,
-    };
-  }
-  const options: any = {};
-  let hydraId;
-
-  if (webex && webex.config && webex.config.meetings && webex.config.meetings.disableHydraId) {
-    hydraId = null;
-  } else {
-    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'
-    );
-
-    options.type = _MEETING_LINK_;
-    options.destination = destination;
-  } else if (MeetingInfoUtil.isSipUri(destination)) {
-    options.type = _SIP_URI_;
-    options.destination = destination;
-  } else if (MeetingInfoUtil.isPhoneNumber(destination)) {
-    options.type = _SIP_URI_;
-    options.destination = destination;
-  } else if (MeetingInfoUtil.isConversationUrl(destination, webex)) {
-    options.type = _CONVERSATION_URL_;
-    options.destination = destination;
-  } else if (hydraId && hydraId.people) {
-    options.type = _SIP_URI_;
-
-    return MeetingInfoUtil.getSipUriFromHydraPersonId(hydraId && hydraId.destination, webex).then(
-      (res) => {
-        options.destination = res;
-
-        // Since hydra person ids require a unique case in which they are
-        // entirely converted to a SIP URI, we need to set a flag for detecting
-        // this type of destination.
-        options.wasHydraPerson = true;
-
-        return Promise.resolve(options);
-      }
-    );
-  } else if (hydraId && hydraId.room) {
-    options.type = _CONVERSATION_URL_;
-    try {
-      await webex.internal.services.waitForCatalog('postauth');
-
-      const serviceUrl = webex.internal.services.getServiceUrlFromClusterId(
-        {
-          cluster: hydraId.cluster,
-        },
-        webex
-      );
-
-      options.destination = hydraId.destination
-        ? `${serviceUrl}/conversations/${hydraId.destination}`
-        : serviceUrl;
-    } catch (e) {
-      LoggerProxy.logger.error(`Meeting-info:util#getDestinationType --> ${e}`);
-      throw e;
-    }
-  } else {
-    LoggerProxy.logger.warn(
-      "Meeting-info:util#getDestinationType --> ('MeetingInfo is fetched with meeting link, sip uri, phone number, hydra room id, hydra people id, or a conversation url."
-    );
-    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);
-};
-
-/**
- * Helper function to build up a correct locus url depending on the value passed
- * @param {Object} options type and value to fetch meeting info
- * @param {String} options.type One of [SIP_URI, PERSONAL_ROOM, MEETING_ID, CONVERSATION_URL, LOCUS_ID, MEETING_LINK]
- * @param {Object} options.destination ?? value.value
- * @returns {Object} returns an object with {resource, method}
- */
-MeetingInfoUtil.getRequestBody = (options: {type: string; destination: object} | any) => {
-  const {type, destination, password, captchaInfo} = options;
-  const body: any = {
-    supportHostKey: true,
-    supportCountryList: true,
-  };
-
-  switch (type) {
-    case _SIP_URI_:
-      body.sipUrl = destination;
-      break;
-    case _PERSONAL_ROOM_:
-      body.userId = destination.userId;
-      body.orgId = destination.orgId;
-      break;
-    case _MEETING_ID_:
-      body.meetingKey = destination;
-      break;
-    case _CONVERSATION_URL_:
-      body.conversationUrl = destination;
-      break;
-    case _LOCUS_ID_:
-      // use meetingID for the completer meeting info for the already started meeting
-      if (destination.info?.webExMeetingId) {
-        body.meetingKey = destination.info.webExMeetingId;
-      } else if (destination.info?.sipUri) {
-        body.sipUrl = destination.info.sipUri;
-      }
-      break;
-    case _MEETING_LINK_:
-      body.meetingUrl = destination;
-      break;
-    case _MEETING_UUID_: {
-      body.meetingUUID = destination;
-      break;
-    }
-    default:
-  }
-
-  if (password) {
-    body.password = password;
-  }
-
-  if (captchaInfo) {
-    body.captchaID = captchaInfo.id;
-    body.captchaVerifyCode = captchaInfo.code;
-  }
-
-  return body;
-};
-
-/**
- * Helper function to parse the webex site/host from a URI string.
- * @param {String} uri string (e.g. '10019857020@convergedats.webex.com')
- * @returns {String} the site/host part of the URI string (e.g. 'convergedats.webex.com')
- */
-MeetingInfoUtil.getWebexSite = (uri: string) => {
-  const exceptedDomains = ['meet.webex.com', 'meetup.webex.com', 'ciscospark.com'];
-  const site = uri?.match(/.+@([^.]+\.[^.]+\.[^.]+)$/)?.[1];
-
-  return exceptedDomains.includes(site) ? null : site;
-};
-
-/**
- * Helper function to return the direct URI for fetching meeting info (to avoid a redirect).
- * @param {Object} options type and value to fetch meeting info
- * @param {String} options.type One of [SIP_URI, PERSONAL_ROOM, MEETING_ID, CONVERSATION_URL, LOCUS_ID, MEETING_LINK]
- * @param {Object} options.destination ?? value.value
- * @returns {String} returns a URI string or null of there is no direct URI
- */
-MeetingInfoUtil.getDirectMeetingInfoURI = (options: {type: string; destination: any}) => {
-  const {type, destination} = options;
-
-  let preferredWebexSite = null;
-
-  switch (type) {
-    case _SIP_URI_:
-      preferredWebexSite = MeetingInfoUtil.getWebexSite(destination);
-      break;
-    case _LOCUS_ID_:
-      preferredWebexSite = destination.info?.webExSite;
-      break;
-    default:
-  }
-
-  return preferredWebexSite ? `https://${preferredWebexSite}/wbxappapi/v1/meetingInfo` : null;
-};
-
-export default MeetingInfoUtil;
+import url from 'url';
+
+// @ts-ignore
+import {deconstructHydraId} from '@webex/common';
+
+import {
+  _SIP_URI_,
+  _PERSONAL_ROOM_,
+  _MEETING_ID_,
+  _CONVERSATION_URL_,
+  _LOCUS_ID_,
+  _MEETING_LINK_,
+  _PEOPLE_,
+  _ROOM_,
+  _MEETING_UUID_,
+  DIALER_REGEX,
+  WEBEX_DOT_COM,
+  CONVERSATION_SERVICE,
+  JOIN,
+  MEET,
+  MEET_M,
+  HTTPS_PROTOCOL,
+  UUID_REG,
+  VALID_EMAIL_ADDRESS,
+} from '../constants';
+import ParameterError from '../common/errors/parameter';
+import LoggerProxy from '../common/logs/logger-proxy';
+
+const MeetingInfoUtil: any = {};
+
+MeetingInfoUtil.getParsedUrl = (link) => {
+  try {
+    let parsedUrl = url.parse(link);
+
+    if (!parsedUrl) {
+      return false;
+    }
+    // hack for links such as <company>.webex.com/meet/<user> without a protocol
+    if (!parsedUrl.protocol) {
+      parsedUrl = url.parse(`${HTTPS_PROTOCOL}${link}`);
+    }
+
+    return parsedUrl;
+  } catch (error) {
+    LoggerProxy.logger.warn(
+      `Meeting-info:util#getParsedUrl --> unable to parse the URL, error: ${error}`
+    );
+
+    return null;
+  }
+};
+
+/**
+ * Helper function to check if a string matches a known meeting link pattern
+ * @param {String} value  string to parse and see if it matches a meeting link
+ * @returns {Boolean}
+ */
+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}`));
+
+  return hostNameBool && pathNameBool;
+};
+
+MeetingInfoUtil.isConversationUrl = (value, webex) => {
+  const clusterId = webex.internal.services.getClusterId(value);
+
+  if (clusterId) {
+    return clusterId.endsWith(CONVERSATION_SERVICE);
+  }
+
+  return false;
+};
+
+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
+  const sipUri = DIALER_REGEX.SIP_ADDRESS.exec(sipString);
+
+  return sipUri;
+};
+
+MeetingInfoUtil.isPhoneNumber = (phoneNumber) => {
+  const isValidNumber = DIALER_REGEX.PHONE_NUMBER.test(phoneNumber);
+
+  return isValidNumber;
+};
+
+MeetingInfoUtil.getHydraId = (destination) => {
+  const {type, id, cluster} = deconstructHydraId(destination);
+
+  if (id && UUID_REG.test(id)) {
+    if (type === _ROOM_) {
+      return {room: true, destination: id, cluster};
+    }
+    if (type === _PEOPLE_) {
+      return {people: true, destination: id, cluster};
+    }
+
+    return {};
+  }
+
+  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.getDestinationType = async (from) => {
+  const {type, webex} = from;
+  let {destination} = from;
+
+  if (type === _PERSONAL_ROOM_) {
+    // this case checks if your type is personal room
+    if (!destination) {
+      // if we are not getting anything in desination we fetch org and user ids from webex instance
+      destination = {
+        userId: webex.internal.device.userId,
+        orgId: webex.internal.device.orgId,
+      };
+    } else {
+      const options = VALID_EMAIL_ADDRESS.test(destination)
+        ? {email: destination}
+        : {id: destination}; // we are assuming userId as default
+      const res = await webex.people.list(options);
+
+      let {orgId, id: userId} = res.items[0];
+
+      userId = deconstructHydraId(userId).id;
+      orgId = deconstructHydraId(orgId).id;
+      destination = {userId, orgId};
+    }
+  }
+  if (type) {
+    return {
+      destination,
+      type,
+    };
+  }
+  const options: any = {};
+  let hydraId;
+
+  if (webex && webex.config && webex.config.meetings && webex.config.meetings.disableHydraId) {
+    hydraId = null;
+  } else {
+    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'
+    );
+
+    options.type = _MEETING_LINK_;
+    options.destination = destination;
+  } else if (MeetingInfoUtil.isSipUri(destination)) {
+    options.type = _SIP_URI_;
+    options.destination = destination;
+  } else if (MeetingInfoUtil.isPhoneNumber(destination)) {
+    options.type = _SIP_URI_;
+    options.destination = destination;
+  } else if (MeetingInfoUtil.isConversationUrl(destination, webex)) {
+    options.type = _CONVERSATION_URL_;
+    options.destination = destination;
+  } else if (hydraId && hydraId.people) {
+    options.type = _SIP_URI_;
+
+    return MeetingInfoUtil.getSipUriFromHydraPersonId(hydraId && hydraId.destination, webex).then(
+      (res) => {
+        options.destination = res;
+
+        // Since hydra person ids require a unique case in which they are
+        // entirely converted to a SIP URI, we need to set a flag for detecting
+        // this type of destination.
+        options.wasHydraPerson = true;
+
+        return Promise.resolve(options);
+      }
+    );
+  } else if (hydraId && hydraId.room) {
+    options.type = _CONVERSATION_URL_;
+    try {
+      await webex.internal.services.waitForCatalog('postauth');
+
+      const serviceUrl = webex.internal.services.getServiceUrlFromClusterId(
+        {
+          cluster: hydraId.cluster,
+        },
+        webex
+      );
+
+      options.destination = hydraId.destination
+        ? `${serviceUrl}/conversations/${hydraId.destination}`
+        : serviceUrl;
+    } catch (e) {
+      LoggerProxy.logger.error(`Meeting-info:util#getDestinationType --> ${e}`);
+      throw e;
+    }
+  } else {
+    LoggerProxy.logger.warn(
+      "Meeting-info:util#getDestinationType --> ('MeetingInfo is fetched with meeting link, sip uri, phone number, hydra room id, hydra people id, or a conversation url."
+    );
+    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);
+};
+
+/**
+ * Helper function to build up a correct locus url depending on the value passed
+ * @param {Object} options type and value to fetch meeting info
+ * @param {String} options.type One of [SIP_URI, PERSONAL_ROOM, MEETING_ID, CONVERSATION_URL, LOCUS_ID, MEETING_LINK]
+ * @param {Object} options.destination ?? value.value
+ * @returns {Object} returns an object with {resource, method}
+ */
+MeetingInfoUtil.getRequestBody = (options: {type: string; destination: object} | any) => {
+  const {type, destination, password, captchaInfo} = options;
+  const body: any = {
+    supportHostKey: true,
+    supportCountryList: true,
+  };
+
+  switch (type) {
+    case _SIP_URI_:
+      body.sipUrl = destination;
+      break;
+    case _PERSONAL_ROOM_:
+      body.userId = destination.userId;
+      body.orgId = destination.orgId;
+      break;
+    case _MEETING_ID_:
+      body.meetingKey = destination;
+      break;
+    case _CONVERSATION_URL_:
+      body.conversationUrl = destination;
+      break;
+    case _LOCUS_ID_:
+      // use meetingID for the completer meeting info for the already started meeting
+      if (destination.info?.webExMeetingId) {
+        body.meetingKey = destination.info.webExMeetingId;
+      } else if (destination.info?.sipUri) {
+        body.sipUrl = destination.info.sipUri;
+      }
+      break;
+    case _MEETING_LINK_:
+      body.meetingUrl = destination;
+      break;
+    case _MEETING_UUID_: {
+      body.meetingUUID = destination;
+      break;
+    }
+    default:
+  }
+
+  if (password) {
+    body.password = password;
+  }
+
+  if (captchaInfo) {
+    body.captchaID = captchaInfo.id;
+    body.captchaVerifyCode = captchaInfo.code;
+  }
+
+  return body;
+};
+
+/**
+ * Helper function to parse the webex site/host from a URI string.
+ * @param {String} uri string (e.g. '10019857020@convergedats.webex.com')
+ * @returns {String} the site/host part of the URI string (e.g. 'convergedats.webex.com')
+ */
+MeetingInfoUtil.getWebexSite = (uri: string) => {
+  const exceptedDomains = ['meet.webex.com', 'meetup.webex.com', 'ciscospark.com'];
+  const site = uri?.match(/.+@([^.]+\.[^.]+\.[^.]+)$/)?.[1];
+
+  return exceptedDomains.includes(site) ? null : site;
+};
+
+/**
+ * Helper function to return the direct URI for fetching meeting info (to avoid a redirect).
+ * @param {Object} options type and value to fetch meeting info
+ * @param {String} options.type One of [SIP_URI, PERSONAL_ROOM, MEETING_ID, CONVERSATION_URL, LOCUS_ID, MEETING_LINK]
+ * @param {Object} options.destination ?? value.value
+ * @returns {String} returns a URI string or null of there is no direct URI
+ */
+MeetingInfoUtil.getDirectMeetingInfoURI = (options: {type: string; destination: any}) => {
+  const {type, destination} = options;
+
+  let preferredWebexSite = null;
+
+  switch (type) {
+    case _SIP_URI_:
+      preferredWebexSite = MeetingInfoUtil.getWebexSite(destination);
+      break;
+    case _LOCUS_ID_:
+      preferredWebexSite = destination.info?.webExSite;
+      break;
+    default:
+  }
+
+  return preferredWebexSite ? `https://${preferredWebexSite}/wbxappapi/v1/meetingInfo` : null;
+};
+
+export default MeetingInfoUtil;