@webex/plugin-meetings 3.0.0-beta.3 → 3.0.0-beta.300

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 the meeting link, SIP URI, phone number, 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,
     };
   }
 

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

@@ -1,7 +1,8 @@
 import url from 'url';
 
 import {
-  deconstructHydraId
+  // @ts-ignore
+  deconstructHydraId,
 } from '@webex/common';
 
 import {
@@ -22,12 +23,16 @@ import {
   MEET_M,
   HTTPS_PROTOCOL,
   UUID_REG,
-  VALID_EMAIL_ADDRESS
+  VALID_EMAIL_ADDRESS,
+  DEFAULT_MEETING_INFO_REQUEST_BODY,
 } from '../constants';
 import ParameterError from '../common/errors/parameter';
 import LoggerProxy from '../common/logs/logger-proxy';
+import {SpaceIDDeprecatedError} from '../common/errors/webex-errors';
 
-const MeetingInfoUtil = {};
+const MeetingInfoUtil: any = {};
+const meetingInfoError =
+  'MeetingInfo is fetched with the meeting link, SIP URI, phone number, Hydra people ID, or a conversation URL.';
 
 MeetingInfoUtil.getParsedUrl = (link) => {
   try {
@@ -42,9 +47,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;
   }
@@ -55,10 +61,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;
 };
@@ -73,7 +83,6 @@ MeetingInfoUtil.isConversationUrl = (value, webex) => {
   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
@@ -105,30 +114,38 @@ 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.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
+  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
+        orgId: webex.internal.device.orgId,
       };
-    }
-    else {
-      const options = VALID_EMAIL_ADDRESS.test(destination) ? {email: destination} : {id: destination};// we are assuming userId as default
+    } 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];
@@ -141,31 +158,29 @@ MeetingInfoUtil.getDestinationType = 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) => {
@@ -178,27 +193,15 @@ MeetingInfoUtil.getDestinationType = async (from) => {
 
       return Promise.resolve(options);
     });
-  }
-  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
-      });
-
-      options.destination = conversationUrl;
-    }
-    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.');
+  } else if (hydraId.room) {
+    LoggerProxy.logger.error(
+      `Meeting-info:util#getDestinationType --> Using the space ID as a destination is no longer supported. Please refer to the [migration guide](https://github.com/webex/webex-js-sdk/wiki/Migration-to-Unified-Space-Meetings) to migrate to use the meeting ID or SIP address.`
+    );
+    // Error code 30105 added as Space ID deprecated as of beta, Please refer migration guide.
+    throw new SpaceIDDeprecatedError();
+  } else {
+    LoggerProxy.logger.warn(`Meeting-info:util#getDestinationType --> ${meetingInfoError}`);
+    throw new ParameterError(`${meetingInfoError}`);
   }
 
   return Promise.resolve(options);
@@ -208,16 +211,15 @@ MeetingInfoUtil.getDestinationType = async (from) => {
  * 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 {String} options.installedOrgID org ID of user's machine
  * @param {Object} options.destination ?? value.value
  * @returns {Object} returns an object with {resource, method}
  */
-MeetingInfoUtil.getRequestBody = (options) => {
-  const {
-    type, destination, password, captchaInfo
-  } = options;
-  const body = {
-    supportHostKey: true,
-    supportCountryList: true,
+MeetingInfoUtil.getRequestBody = (options: {type: string; destination: object} | any) => {
+  const {type, destination, password, captchaInfo, installedOrgID, locusId, extraParams} = options;
+  const body: any = {
+    ...DEFAULT_MEETING_INFO_REQUEST_BODY,
+    ...extraParams,
   };
 
   switch (type) {
@@ -238,8 +240,7 @@ MeetingInfoUtil.getRequestBody = (options) => {
       // 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) {
+      } else if (destination.info?.sipUri) {
         body.sipUrl = destination.info.sipUri;
       }
       break;
@@ -262,6 +263,14 @@ MeetingInfoUtil.getRequestBody = (options) => {
     body.captchaVerifyCode = captchaInfo.code;
   }
 
+  if (installedOrgID) {
+    body.installedOrgID = installedOrgID;
+  }
+
+  if (locusId) {
+    body.locusId = locusId;
+  }
+
   return body;
 };
 
@@ -270,7 +279,7 @@ MeetingInfoUtil.getRequestBody = (options) => {
  * @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) => {
+MeetingInfoUtil.getWebexSite = (uri: string) => {
   const exceptedDomains = ['meet.webex.com', 'meetup.webex.com', 'ciscospark.com'];
   const site = uri?.match(/.+@([^.]+\.[^.]+\.[^.]+)$/)?.[1];
 
@@ -284,10 +293,8 @@ MeetingInfoUtil.getWebexSite = (uri) => {
  * @param {Object} options.destination ?? value.value
  * @returns {String} returns a URI string or null of there is no direct URI
  */
-MeetingInfoUtil.getDirectMeetingInfoURI = (options) => {
-  const {
-    type, destination
-  } = options;
+MeetingInfoUtil.getDirectMeetingInfoURI = (options: {type: string; destination: any}) => {
+  const {type, destination} = options;
 
   let preferredWebexSite = null;
 

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

@@ -1,6 +1,7 @@
 import {find} from 'lodash';
 
 import Collection from '../common/collection';
+
 /**
  * @export
  * @class MeetingCollection
@@ -16,12 +17,13 @@ export default class MeetingCollection extends Collection {
   }
 
   set(meeting) {
+    // @ts-ignore
     this.meetings[meeting.id] = meeting;
 
+    // @ts-ignore
     return this.meetings[meeting.id];
   }
 
-
   /**
    * get a specific meeting searching for key
    * @param {String} key
@@ -30,9 +32,30 @@ export default class MeetingCollection extends Collection {
    * @public
    * @memberof MeetingCollection
    */
-  getByKey(key, value) {
+  public getByKey(key: string, value: any) {
     if (key && value) {
-      return find(this.meetings, (meeting) => (meeting[key] === value));
+      // @ts-ignore
+      return find(this.meetings, (meeting) => meeting[key] === value);
+    }
+
+    return null;
+  }
+
+  /**
+   * get a specific meeting searching for key
+   * @param {String} breakoutUrl
+   * @returns {Meeting} if found, else returns null
+   * @public
+   * @memberof MeetingCollection
+   */
+  public getActiveBreakoutLocus(breakoutUrl: string) {
+    if (breakoutUrl) {
+      // @ts-ignore
+      return find(
+        // @ts-ignore
+        this.meetings,
+        (meeting) => meeting.breakouts?.url === breakoutUrl && meeting.breakouts?.isActiveBreakout
+      );
     }
 
     return null;