@webex/plugin-meetings 3.0.0 → 3.1.0-next.2

package/src/meeting-info/utilv2.ts

@@ -30,169 +30,176 @@ import ParameterError from '../common/errors/parameter';
 import LoggerProxy from '../common/logs/logger-proxy';
 import {SpaceIDDeprecatedError} from '../common/errors/webex-errors';
 
-const MeetingInfoUtil: any = {};
-const meetingInfoError =
-  'MeetingInfo is fetched with the meeting link, SIP URI, phone number, Hydra people ID, or a conversation URL.';
+/**
+ * @class MeetingInfoUtil
+ */
+export default class MeetingInfoUtil {
+  static meetingInfoError =
+    'MeetingInfo is fetched with the meeting link, SIP URI, phone number, Hydra people ID, or a conversation URL.';
 
-MeetingInfoUtil.getParsedUrl = (link) => {
-  try {
-    let parsedUrl = url.parse(link);
+  static 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}`);
+      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;
     }
+  }
 
-    return parsedUrl;
-  } catch (error) {
-    LoggerProxy.logger.warn(
-      `Meeting-info:util#getParsedUrl --> unable to parse the URL, error: ${error}`
-    );
+  /**
+   * 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}
+   */
+  static isMeetingLink(value: string) {
+    let hostNameBool;
+    let pathNameBool;
+    const parsedUrl = this.getParsedUrl(value);
+    if (parsedUrl) {
+      hostNameBool = parsedUrl.hostname && parsedUrl.hostname.includes(WEBEX_DOT_COM);
+      pathNameBool =
+        parsedUrl.pathname &&
+        (parsedUrl.pathname.includes(`/${MEET}`) ||
+          parsedUrl.pathname.includes(`/${MEET_M}`) ||
+          parsedUrl.pathname.includes(`/${MEET_CISCO}`) ||
+          parsedUrl.pathname.includes(`/${MEET_CO}`) ||
+          parsedUrl.pathname.includes(`/${JOIN}`));
+    }
 
-    return null;
+    return hostNameBool && pathNameBool;
   }
-};
 
-/**
- * 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(`/${MEET_CISCO}`) ||
-      parsedUrl.pathname.includes(`/${MEET_CO}`) ||
-      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);
+  static isConversationUrl(value, webex) {
+    const clusterId = webex.internal.services.getClusterId(value);
+
+    if (clusterId) {
+      return clusterId.endsWith(CONVERSATION_SERVICE);
+    }
+
+    return false;
   }
 
-  return false;
-};
+  static 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);
 
-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;
+  }
 
-  return sipUri;
-};
+  static isPhoneNumber(phoneNumber) {
+    const isValidNumber = DIALER_REGEX.PHONE_NUMBER.test(phoneNumber);
 
-MeetingInfoUtil.isPhoneNumber = (phoneNumber) => {
-  const isValidNumber = DIALER_REGEX.PHONE_NUMBER.test(phoneNumber);
+    return isValidNumber;
+  }
 
-  return isValidNumber;
-};
+  static getHydraId(destination) {
+    const {type, id, cluster} = deconstructHydraId(destination);
 
-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};
+      }
 
-  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 {};
   }
 
-  return {};
-};
+  static getSipUriFromHydraPersonId(destination, webex) {
+    return 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];
+  static async getDestinationType(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};
       }
-      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,
+    }
+    if (type) {
+      return {
+        destination,
+        type,
       };
-    } 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];
+    }
+    const options: any = {};
+    let hydraId;
 
-      userId = deconstructHydraId(userId).id;
-      orgId = deconstructHydraId(orgId).id;
-      destination = {userId, orgId};
+    if (webex && webex.config && webex.config.meetings && webex.config.meetings.disableHydraId) {
+      hydraId = null;
+    } else {
+      hydraId = this.getHydraId(destination);
     }
-  }
-  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 (this.isMeetingLink(destination)) {
+      LoggerProxy.logger.warn(
+        'Meeting-info:util#generateOptions --> WARN, use of Meeting Link is deprecated, please use a SIP URI instead'
+      );
 
-  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.type = _MEETING_LINK_;
+      options.destination = destination;
+    } else if (this.isSipUri(destination)) {
+      options.type = _SIP_URI_;
+      options.destination = destination;
+    } else if (this.isPhoneNumber(destination)) {
+      options.type = _SIP_URI_;
+      options.destination = destination;
+    } else if (this.isConversationUrl(destination, webex)) {
+      options.type = _CONVERSATION_URL_;
+      options.destination = destination;
+    } else if (hydraId && hydraId.people) {
+      options.type = _SIP_URI_;
+
+      return this.getSipUriFromHydraPersonId(hydraId && hydraId.destination, webex).then((res) => {
         options.destination = res;
 
         // Since hydra person ids require a unique case in which they are
@@ -201,124 +208,124 @@ MeetingInfoUtil.getDestinationType = async (from) => {
         options.wasHydraPerson = true;
 
         return Promise.resolve(options);
-      }
-    );
-  } 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}`);
+      });
+    } 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 --> ${this.meetingInfoError}`);
+      throw new ParameterError(`${this.meetingInfoError}`);
+    }
+
+    return Promise.resolve(options);
   }
 
-  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 {String} options.installedOrgID org ID of user's machine
+   * @param {Object} options.destination ?? value.value
+   * @returns {Object} returns an object with {resource, method}
+   */
+  static 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,
+    };
 
-/**
- * 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: {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) {
-    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;
+    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;
       }
-      break;
-    case _MEETING_LINK_:
-      body.meetingUrl = destination;
-      break;
-    case _MEETING_UUID_: {
-      body.meetingUUID = destination;
-      break;
+      default:
     }
-    default:
-  }
-
-  if (password) {
-    body.password = password;
-  }
 
-  if (captchaInfo) {
-    body.captchaID = captchaInfo.id;
-    body.captchaVerifyCode = captchaInfo.code;
-  }
-
-  if (installedOrgID) {
-    body.installedOrgID = installedOrgID;
-  }
+    if (password) {
+      body.password = password;
+    }
 
-  if (locusId) {
-    body.locusId = locusId;
-  }
+    if (captchaInfo) {
+      body.captchaID = captchaInfo.id;
+      body.captchaVerifyCode = captchaInfo.code;
+    }
 
-  return body;
-};
+    if (installedOrgID) {
+      body.installedOrgID = installedOrgID;
+    }
 
-/**
- * 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];
+    if (locusId) {
+      body.locusId = locusId;
+    }
 
-  return exceptedDomains.includes(site) ? null : site;
-};
+    return body;
+  }
 
-/**
- * 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:
+  /**
+   * 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')
+   */
+  static getWebexSite(uri: string) {
+    const exceptedDomains = ['meet.webex.com', 'meetup.webex.com', 'ciscospark.com'];
+    const site = uri?.match(/.+@([^.]+\.[^.]+\.[^.]+)$/)?.[1];
+    const isExceptedDomain = !!site && exceptedDomains.some((domain) => site.includes(domain));
+
+    return isExceptedDomain ? null : site;
   }
 
-  return preferredWebexSite ? `https://${preferredWebexSite}/wbxappapi/v1/meetingInfo` : null;
-};
+  /**
+   * 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
+   */
+  static getDirectMeetingInfoURI(options: {type: string; destination: any}) {
+    const {type, destination} = options;
+
+    let preferredWebexSite = null;
+
+    switch (type) {
+      case _SIP_URI_:
+        preferredWebexSite = this.getWebexSite(destination);
+        break;
+      case _LOCUS_ID_:
+        preferredWebexSite = destination.info?.webExSite;
+        break;
+      default:
+    }
 
-export default MeetingInfoUtil;
+    return preferredWebexSite ? `https://${preferredWebexSite}/wbxappapi/v1/meetingInfo` : null;
+  }
+}

package/src/meetings/index.ts

@@ -717,6 +717,24 @@ export default class Meetings extends WebexPlugin {
     }
   }
 
+  /**
+   * API to toggle TLS reachability, needs to be called before webex.meetings.register()
+   * @param {Boolean} newValue
+   * @private
+   * @memberof Meetings
+   * @returns {undefined}
+   */
+  private _toggleTlsReachability(newValue: boolean) {
+    if (typeof newValue !== 'boolean') {
+      return;
+    }
+    // @ts-ignore
+    if (this.config.experimental.enableTlsReachability !== newValue) {
+      // @ts-ignore
+      this.config.experimental.enableTlsReachability = newValue;
+    }
+  }
+
   /**
    * Explicitly sets up the meetings plugin by registering
    * the device, connecting to mercury, and listening for locus events.

package/src/multistream/mediaRequestManager.ts

@@ -8,6 +8,7 @@ import {
   H264Codec,
   getRecommendedMaxBitrateForFrameSize,
   RecommendedOpusBitrates,
+  NamedMediaGroup,
 } from '@webex/internal-media-core';
 import {cloneDeepWith, debounce, isEmpty} from 'lodash';
 
@@ -22,6 +23,7 @@ export interface ActiveSpeakerPolicyInfo {
   crossPriorityDuplication: boolean;
   crossPolicyDuplication: boolean;
   preferLiveVideo: boolean;
+  namedMediaGroups?: NamedMediaGroup[];
 }
 
 export interface ReceiverSelectedPolicyInfo {
@@ -347,7 +349,8 @@ export class MediaRequestManager {
                   mr.policyInfo.priority,
                   mr.policyInfo.crossPriorityDuplication,
                   mr.policyInfo.crossPolicyDuplication,
-                  mr.policyInfo.preferLiveVideo
+                  mr.policyInfo.preferLiveVideo,
+                  mr.policyInfo.namedMediaGroups
                 )
               : new ReceiverSelectedInfo(mr.policyInfo.csi),
             mr.receiveSlots.map((receiveSlot) => receiveSlot.wcmeReceiveSlot),

package/src/multistream/remoteMediaGroup.ts

@@ -2,6 +2,7 @@
 /* eslint-disable require-jsdoc */
 /* eslint-disable import/prefer-default-export */
 import {forEach} from 'lodash';
+import {NamedMediaGroup} from '@webex/internal-media-core';
 import LoggerProxy from '../common/logs/logger-proxy';
 
 import {getMaxFs, RemoteMedia, RemoteVideoResolution} from './remoteMedia';
@@ -11,6 +12,7 @@ import {CSI, ReceiveSlot} from './receiveSlot';
 type Options = {
   resolution?: RemoteVideoResolution; // applies only to groups of type MediaType.VideoMain and MediaType.VideoSlides
   preferLiveVideo?: boolean; // applies only to groups of type MediaType.VideoMain and MediaType.VideoSlides
+  namedMediaGroup?: NamedMediaGroup; // applies only to named media groups for audio
 };
 
 export class RemoteMediaGroup {
@@ -221,6 +223,9 @@ export class RemoteMediaGroup {
           crossPriorityDuplication: false,
           crossPolicyDuplication: false,
           preferLiveVideo: !!this.options?.preferLiveVideo,
+          namedMediaGroups: this.options.namedMediaGroup?.value
+            ? [this.options?.namedMediaGroup]
+            : undefined,
         },
         receiveSlots: this.unpinnedRemoteMedia.map((remoteMedia) =>
           remoteMedia.getUnderlyingReceiveSlot()
@@ -241,6 +246,20 @@ export class RemoteMediaGroup {
     }
   }
 
+  /**
+   * setNamedMediaGroup - sets named media group type and value
+   * @internal
+   */
+  public setNamedMediaGroup(namedMediaGroup: NamedMediaGroup, commit: boolean) {
+    if (
+      this.options.namedMediaGroup.value !== namedMediaGroup.value ||
+      this.options.namedMediaGroup.type !== namedMediaGroup.type
+    ) {
+      this.options.namedMediaGroup = namedMediaGroup;
+      this.sendActiveSpeakerMediaRequest(commit);
+    }
+  }
+
   /**
    * Invalidates the remote media group by clearing the references to the receive slots
    * used by all remote media from that group and cancelling all media requests.