@webex/plugin-meetings 3.0.0-beta.9 → 3.0.0-bnr.0

package/src/breakouts/request.ts

@@ -0,0 +1,55 @@
+import {StatelessWebexPlugin} from '@webex/webex-core';
+import LoggerProxy from '../common/logs/logger-proxy';
+import {getBroadcastRoles} from './utils';
+import {HTTP_VERBS} from '../constants';
+
+/**
+ * @class BreakoutRequest
+ */
+export default class BreakoutRequest extends StatelessWebexPlugin {
+  /**
+   * Broadcast message to all breakout session's participants
+   * @param {String} url
+   * @param {String} message
+   * @param {Object} options
+   * @param {string} groupId
+   * @param {string} sessionId
+   * @returns {Promise}
+   */
+  broadcast({
+    url,
+    message,
+    options,
+    groupId,
+    sessionId,
+  }: {
+    url: string;
+    message: string;
+    options?: object;
+    groupId: string;
+    sessionId?: string;
+  }) {
+    const roles = getBroadcastRoles(options);
+    const params = {
+      id: groupId,
+      recipientRoles: roles.length ? roles : undefined,
+      sessions: sessionId ? [{id: sessionId}] : undefined,
+    };
+
+    // @ts-ignore
+    return this.request({
+      method: HTTP_VERBS.POST,
+      uri: `${url}/message`,
+      body: {
+        message,
+        groups: [params],
+      },
+    }).catch((error) => {
+      if (error.body && error.body.errorCode === 201409036 && error.statusCode === 409) {
+        LoggerProxy.logger.info(`Breakouts#broadcast --> no joined participants`);
+      } else {
+        throw error;
+      }
+    });
+  }
+}

package/src/breakouts/utils.ts

@@ -0,0 +1,44 @@
+// eslint-disable-next-line import/prefer-default-export
+import LoggerProxy from '../common/logs/logger-proxy';
+import BreakoutEditLockedError from './edit-lock-error';
+import {BREAKOUTS} from '../constants';
+
+export const getBroadcastRoles = (options): string[] => {
+  const recipientRoles = [];
+  if (!options || (!options.cohosts && !options.presenters)) {
+    return recipientRoles;
+  }
+  if (options.cohosts) {
+    recipientRoles.push('COHOST');
+  }
+  if (options.presenters) {
+    recipientRoles.push('PRESENTER');
+  }
+
+  return recipientRoles;
+};
+
+/**
+ * Deals with all kinds of errors of breakout service
+ * @param {object} error // one of the breakout service error
+ * @param {string} position // position of the error occur
+ * @returns {object}
+ */
+export const boServiceErrorHandler = (error: any, position: string): any => {
+  const errorCode = error?.body?.errorCode;
+  const {EDIT_LOCK_TOKEN_MISMATCH, EDIT_NOT_AUTHORIZED} = BREAKOUTS.ERROR_CODE;
+  let throwError;
+  switch (errorCode) {
+    case EDIT_LOCK_TOKEN_MISMATCH:
+      throwError = new BreakoutEditLockedError('Edit lock token mismatch', error);
+      break;
+    case EDIT_NOT_AUTHORIZED:
+      throwError = new BreakoutEditLockedError('Not authorized to interact with edit lock', error);
+      break;
+    default:
+      throwError = error;
+  }
+  LoggerProxy.logger.info(`${position} --> ${throwError?.message}`);
+
+  return throwError;
+};

package/src/common/browser-detection.ts

@@ -1,3 +1,5 @@
+/* eslint-disable @typescript-eslint/no-var-requires */
+
 import bowser from 'bowser';
 import {memoize} from 'lodash';
 import window from 'global/window';
@@ -9,7 +11,7 @@ const mockDetectionObject = {
   /* eslint-enable global-require */
   getBrowserName: () => '',
   getBrowserVersion: () => '',
-  isBrowser: () => false
+  isBrowser: () => false,
 };
 
 const createDetectionObject = (results) => {
@@ -26,11 +28,12 @@ const createDetectionObject = (results) => {
     getOSVersion,
     getBrowserName,
     getBrowserVersion,
-    isBrowser
+    isBrowser,
   };
 };
 
-export default memoize((agent?: any) => (agent || window.navigator?.userAgent ?
-  createDetectionObject(bowser.getParser(agent || window.navigator.userAgent)) :
-  mockDetectionObject
-));
+export default memoize((agent?: any) =>
+  agent || window.navigator?.userAgent
+    ? createDetectionObject(bowser.getParser(agent || window.navigator.userAgent))
+    : mockDetectionObject
+);

package/src/common/collection.ts

@@ -42,7 +42,9 @@ export default class Collection {
    * @memberof Collection
    */
   public get(id: string) {
-    return this[this.propertyName] && this[this.propertyName][id] ? this[this.propertyName][id] : null;
+    return this[this.propertyName] && this[this.propertyName][id]
+      ? this[this.propertyName][id]
+      : null;
   }
 
   /**

package/src/common/errors/captcha-error.ts

@@ -9,17 +9,17 @@ export default class CaptchaError extends Error {
   sdkMessage: any;
 
   /**
-  *
-  * @constructor
-  * @param {String} [message]
-  * @param {Object} [error]
-  */
+   *
+   * @constructor
+   * @param {String} [message]
+   * @param {Object} [error]
+   */
   constructor(message: string = ERROR_DICTIONARY.CAPTCHA.MESSAGE, error: any = null) {
     super(message);
     this.name = ERROR_DICTIONARY.CAPTCHA.NAME;
     this.sdkMessage = ERROR_DICTIONARY.CAPTCHA.MESSAGE;
     this.error = error;
-    this.stack = error ? error.stack : (new Error()).stack;
+    this.stack = error ? error.stack : new Error().stack;
     this.code = ERROR_DICTIONARY.CAPTCHA.CODE;
   }
 }

package/src/common/errors/intent-to-join.ts

@@ -10,17 +10,17 @@ export default class IntentToJoinError extends Error {
   sdkMessage: any;
 
   /**
-  *
-  * @constructor
-  * @param {String} [message]
-  * @param {Object} [error]
-  */
+   *
+   * @constructor
+   * @param {String} [message]
+   * @param {Object} [error]
+   */
   constructor(message: string = ERROR_DICTIONARY.INTENT_TO_JOIN.MESSAGE, error: any = null) {
     super(message);
     this.name = ERROR_DICTIONARY.INTENT_TO_JOIN.NAME;
     this.sdkMessage = ERROR_DICTIONARY.INTENT_TO_JOIN.MESSAGE;
     this.error = error;
-    this.stack = error ? error.stack : (new Error()).stack;
+    this.stack = error ? error.stack : new Error().stack;
     this.joinIntentRequired = true;
     this.code = ERROR_DICTIONARY.INTENT_TO_JOIN.CODE;
   }

package/src/common/errors/join-meeting.ts

@@ -10,18 +10,22 @@ export default class JoinMeetingError extends Error {
   sdkMessage: any;
 
   /**
-  *
-  * @constructor
-  * @param {Object} [options]
-  * @param {String} [message]
-  * @param {Object} [error]
-  */
-  constructor(options: object = {}, message: string = ERROR_DICTIONARY.JOIN_MEETING.MESSAGE, error: any = null) {
+   *
+   * @constructor
+   * @param {Object} [options]
+   * @param {String} [message]
+   * @param {Object} [error]
+   */
+  constructor(
+    options: object = {},
+    message: string = ERROR_DICTIONARY.JOIN_MEETING.MESSAGE,
+    error: any = null
+  ) {
     super(message);
     this.name = ERROR_DICTIONARY.JOIN_MEETING.NAME;
     this.sdkMessage = ERROR_DICTIONARY.JOIN_MEETING.MESSAGE;
     this.error = error;
-    this.stack = error ? error.stack : (new Error()).stack;
+    this.stack = error ? error.stack : new Error().stack;
     this.joinOptions = options;
     this.code = ERROR_DICTIONARY.JOIN_MEETING.CODE;
   }

package/src/common/errors/media.ts

@@ -9,17 +9,17 @@ export default class MediaError extends Error {
   sdkMessage: any;
 
   /**
-  *
-  * @constructor
-  * @param {String} [message]
-  * @param {Object} [error]
-  */
+   *
+   * @constructor
+   * @param {String} [message]
+   * @param {Object} [error]
+   */
   constructor(message: string = ERROR_DICTIONARY.MEDIA.MESSAGE, error: any = null) {
     super(message);
     this.name = ERROR_DICTIONARY.RECONNECTION.NAME;
     this.sdkMessage = ERROR_DICTIONARY.MEDIA.MESSAGE;
     this.error = error;
-    this.stack = error ? error.stack : (new Error()).stack;
+    this.stack = error ? error.stack : new Error().stack;
     this.code = ERROR_DICTIONARY.RECONNECTION.CODE;
   }
 }

package/src/common/errors/parameter.ts

@@ -9,12 +9,15 @@ export default class ParameterError extends Error {
   code: number;
 
   /**
-  *
-  * @constructor
-  * @param {String} [message]
-  * @param {Object} [error]
-  */
-  constructor(message: string = MEETINGCONSTANTS.ERROR_DICTIONARY.PARAMETER.MESSAGE, error: any = null) {
+   *
+   * @constructor
+   * @param {String} [message]
+   * @param {Object} [error]
+   */
+  constructor(
+    message: string = MEETINGCONSTANTS.ERROR_DICTIONARY.PARAMETER.MESSAGE,
+    error: any = null
+  ) {
     super(message);
 
     if (Error.captureStackTrace) {

package/src/common/errors/password-error.ts

@@ -9,17 +9,17 @@ export default class PasswordError extends Error {
   sdkMessage: any;
 
   /**
-  *
-  * @constructor
-  * @param {String} [message]
-  * @param {Object} [error]
-  */
+   *
+   * @constructor
+   * @param {String} [message]
+   * @param {Object} [error]
+   */
   constructor(message: string = ERROR_DICTIONARY.PASSWORD.MESSAGE, error: any = null) {
     super(message);
     this.name = ERROR_DICTIONARY.PASSWORD.NAME;
     this.sdkMessage = ERROR_DICTIONARY.PASSWORD.MESSAGE;
     this.error = error;
-    this.stack = error ? error.stack : (new Error()).stack;
+    this.stack = error ? error.stack : new Error().stack;
     this.code = ERROR_DICTIONARY.PASSWORD.CODE;
   }
 }

package/src/common/errors/permission.ts

@@ -9,16 +9,16 @@ export default class PermissionError extends Error {
   sdkMessage: any;
 
   /**
-  * @constructor
-  * @param {String} [message]
-  * @param {Object} [error]
-  */
+   * @constructor
+   * @param {String} [message]
+   * @param {Object} [error]
+   */
   constructor(message: string = ERROR_DICTIONARY.PERMISSION.MESSAGE, error: any = null) {
     super(message);
     this.name = ERROR_DICTIONARY.PERMISSION.NAME;
     this.sdkMessage = ERROR_DICTIONARY.PERMISSION.MESSAGE;
     this.error = error;
-    this.stack = error ? error.stack : (new Error()).stack;
+    this.stack = error ? error.stack : new Error().stack;
     this.code = ERROR_DICTIONARY.PERMISSION.CODE;
   }
 }

package/src/common/errors/reconnection.ts

@@ -9,17 +9,17 @@ export default class ReconnectionError extends Error {
   sdkMessage: any;
 
   /**
-  *
-  * @constructor
-  * @param {String} [message]
-  * @param {Object} [error]
-  */
+   *
+   * @constructor
+   * @param {String} [message]
+   * @param {Object} [error]
+   */
   constructor(message: string = ERROR_DICTIONARY.RECONNECTION.MESSAGE, error: any = null) {
     super(message);
     this.name = ERROR_DICTIONARY.RECONNECTION.NAME;
     this.sdkMessage = ERROR_DICTIONARY.RECONNECTION.MESSAGE;
     this.error = error;
-    this.stack = error ? error.stack : (new Error()).stack;
+    this.stack = error ? error.stack : new Error().stack;
     this.code = ERROR_DICTIONARY.RECONNECTION.CODE;
   }
 }

package/src/common/errors/stats.ts

@@ -9,17 +9,17 @@ export default class StatsError extends Error {
   sdkMessage: any;
 
   /**
-  *
-  * @constructor
-  * @param {String} [message]
-  * @param {Object} [error]
-  */
+   *
+   * @constructor
+   * @param {String} [message]
+   * @param {Object} [error]
+   */
   constructor(message: string = ERROR_DICTIONARY.STATS.MESSAGE, error: any = null) {
     super(message);
     this.name = ERROR_DICTIONARY.STATS.NAME;
     this.sdkMessage = ERROR_DICTIONARY.STATS.MESSAGE;
     this.error = error;
-    this.stack = error ? error.stack : (new Error()).stack;
+    this.stack = error ? error.stack : new Error().stack;
     this.code = ERROR_DICTIONARY.STATS.CODE;
   }
 }

package/src/common/errors/webex-errors.ts

@@ -23,7 +23,9 @@ export function createMeetingsError(code?: number, message?: string) {
   code = typeof code === 'number' ? code : 0;
   message = typeof message === 'string' && message ? message : 'Unknown error';
 
-  return WebExMeetingsErrors[code] ? new WebExMeetingsErrors[code]() : new WebexMeetingsError(code, message);
+  return WebExMeetingsErrors[code]
+    ? new WebExMeetingsErrors[code]()
+    : new WebexMeetingsError(code, message);
 }
 
 /**
@@ -55,14 +57,16 @@ class UserNotJoinedError extends WebexMeetingsError {
   static CODE = 30102;
 
   constructor() {
-    super(UserNotJoinedError.CODE, 'User currently not in meeting. Please join a meeting before adding media.');
+    super(
+      UserNotJoinedError.CODE,
+      'User currently not in meeting. Please join a meeting before adding media.'
+    );
   }
 }
 
 export {UserNotJoinedError};
 WebExMeetingsErrors[UserNotJoinedError.CODE] = UserNotJoinedError;
 
-
 /**
  * @class NoMediaEstablishedYetError
  * @classdesc Raised whenever the user has not established media yet.
@@ -81,7 +85,6 @@ class NoMediaEstablishedYetError extends WebexMeetingsError {
 export {NoMediaEstablishedYetError};
 WebExMeetingsErrors[NoMediaEstablishedYetError.CODE] = NoMediaEstablishedYetError;
 
-
 /**
  * @class UserInLobbyError
  * @classdesc Raised whenever the user is in lobby and not joined yet.
@@ -100,7 +103,6 @@ class UserInLobbyError extends WebexMeetingsError {
 export {UserInLobbyError};
 WebExMeetingsErrors[UserInLobbyError.CODE] = UserInLobbyError;
 
-
 /**
  * @class IceGatheringFailed
  * @classdesc Raised whenever ice gathering fails.

package/src/common/errors/webex-meetings-error.ts

@@ -19,7 +19,7 @@ export default class WebexMeetingsError extends Error {
 
     Object.defineProperty(this, 'code', {
       value: code,
-      enumerable: true
+      enumerable: true,
     });
   }
 

package/src/common/events/events-scope.ts

@@ -19,7 +19,11 @@ export default class EventsScope extends ChildEmitter {
    * @returns {Function}
    */
   emit(scope: any, eventName: any, args: any) {
-    LoggerProxy.logger.debug(`${EventsUtil.getScopeLog(scope)}event#${eventName}${LoggerConfig.verboseEvents ? ` -- ${EventsUtil.getEventLog(args)}` : ''}`);
+    LoggerProxy.logger.debug(
+      `${EventsUtil.getScopeLog(scope)}event#${eventName}${
+        LoggerConfig.verboseEvents ? ` -- ${EventsUtil.getEventLog(args)}` : ''
+      }`
+    );
 
     return super.emit(eventName, args);
   }

package/src/common/events/events.ts

@@ -12,7 +12,11 @@ import EventsUtil from './util';
  */
 class Events extends EventEmitter {
   emit(scope, eventName, args) {
-    LoggerProxy.logger.debug(`${EventsUtil.getScopeLog(scope)}event#${eventName}${LoggerConfig.verboseEvents ? ` -- ${EventsUtil.getEventLog(args)}` : ''}`);
+    LoggerProxy.logger.debug(
+      `${EventsUtil.getScopeLog(scope)}event#${eventName}${
+        LoggerConfig.verboseEvents ? ` -- ${EventsUtil.getEventLog(args)}` : ''
+      }`
+    );
 
     return super.emit(eventName, args);
   }

package/src/common/events/trigger-proxy.ts

@@ -4,15 +4,20 @@ import ParameterError from '../errors/parameter';
 
 import EventsUtil from './util';
 
-
 const TriggerProxy: any = {};
 
 TriggerProxy.trigger = (instance, scope, trigger, payload) => {
   if (!instance || !instance.trigger) {
-    throw new ParameterError('Instance to trigger from must be defined and have a trigger function.');
+    throw new ParameterError(
+      'Instance to trigger from must be defined and have a trigger function.'
+    );
   }
 
-  LoggerProxy.logger.debug(`${EventsUtil.getScopeLog(scope)}event#${trigger}${LoggerConfig.verboseEvents ? ` -- ${EventsUtil.getEventLog(payload)}` : ''}`);
+  LoggerProxy.logger.debug(
+    `${EventsUtil.getScopeLog(scope)}event#${trigger}${
+      LoggerConfig.verboseEvents ? ` -- ${EventsUtil.getEventLog(payload)}` : ''
+    }`
+  );
 
   return instance.trigger(trigger, payload);
 };

package/src/common/events/util.ts

@@ -9,8 +9,7 @@ EventsUtil.getEventLog = (args) => {
 
   try {
     argString = inspect(args);
-  }
-  catch (e) {
+  } catch (e) {
     LoggerProxy.logger.warn(`Events:util#getEventLog --> ${e}`);
   }
 

package/src/common/logs/logger-proxy.ts

@@ -3,13 +3,25 @@ import LoggerConfig from './logger-config';
 
 const LoggerProxy: any = {
   logger: {
-    info: (args) => { console.error('LoggerProxy->info#NO LOGGER DEFINED'); },
-    log: (args) => { console.error('LoggerProxy->log#NO LOGGER DEFINED'); },
-    error: (args) => { console.error('LoggerProxy->error#NO LOGGER DEFINED'); },
-    warn: (args) => { console.error('LoggerProxy->warn#NO LOGGER DEFINED'); },
-    trace: (args) => { console.error('LoggerProxy->trace#NO LOGGER DEFINED'); },
-    debug: (args) => { console.error('LoggerProxy->debug#NO LOGGER DEFINED'); }
-  }
+    info: (args) => {
+      console.error('LoggerProxy->info#NO LOGGER DEFINED');
+    },
+    log: (args) => {
+      console.error('LoggerProxy->log#NO LOGGER DEFINED');
+    },
+    error: (args) => {
+      console.error('LoggerProxy->error#NO LOGGER DEFINED');
+    },
+    warn: (args) => {
+      console.error('LoggerProxy->warn#NO LOGGER DEFINED');
+    },
+    trace: (args) => {
+      console.error('LoggerProxy->trace#NO LOGGER DEFINED');
+    },
+    debug: (args) => {
+      console.error('LoggerProxy->debug#NO LOGGER DEFINED');
+    },
+  },
 };
 
 LoggerProxy.set = (logger) => {
@@ -20,10 +32,9 @@ LoggerProxy.set = (logger) => {
       error: () => {},
       warn: () => {},
       trace: () => {},
-      debug: () => {}
+      debug: () => {},
     };
-  }
-  else {
+  } else {
     LoggerProxy.logger = logger;
   }
 };

package/src/common/logs/request.ts

@@ -14,7 +14,7 @@ export default class LogsRequest {
    * @param {Object} options.webex Webex SDK instance
    * @param {ClientMetrics} metrics
    */
-  constructor(options: { webex: object }) {
+  constructor(options: {webex: object}) {
     this.webex = options.webex;
   }
 
@@ -40,18 +40,21 @@ export default class LogsRequest {
     } = {}
   ) {
     const id = options.feedbackId || uuid.v4();
-    const {
-      locusId, correlationId, meetingId, callStart
-    } = options;
+    const {locusId, correlationId, meetingId, callStart} = options;
 
-    LoggerProxy.logger.info(`Logs:request#uploadLogs --> uploading user logs for feedbackId: ${id}`);
+    LoggerProxy.logger.info(
+      `Logs:request#uploadLogs --> uploading user logs for feedbackId: ${id}`
+    );
 
     try {
       await this.webex.internal.support.submitLogs({
-        feedbackId: id, locusId, correlationId, meetingId, callStart
+        feedbackId: id,
+        locusId,
+        correlationId,
+        meetingId,
+        callStart,
       });
-    }
-    catch (error) {
+    } catch (error) {
       LoggerProxy.logger.error('Logs:request#uploadLogs --> uploading user logs failed', error);
 
       return Promise.reject(error);

package/src/config.ts

@@ -1,6 +1,6 @@
 import {
   // @ts-ignore
-  deviceType
+  deviceType,
 } from '@webex/common';
 
 export default {
@@ -16,7 +16,7 @@ export default {
       receiveVideo: true,
       pstn: false,
       sendShare: false,
-      receiveShare: false
+      receiveShare: false,
     },
     reconnection: {
       enabled: false,
@@ -25,7 +25,7 @@ export default {
       // Timeout duration to wait for ICE to reconnect if a disconnect is received.
       iceReconnectionTimeout: 10000,
       // Amount of times attempting to rejoin a meeting during reconnect
-      maxRejoinAttempts: 3
+      maxRejoinAttempts: 3,
     },
     stats: {
       // Enable the webrtc stats analyzer that emits quality degradation events
@@ -41,7 +41,7 @@ export default {
       // Once packet loss hits this ratio, the video will downgrade
       videoPacketLossRatioThreshold: 9, // comparison of packets lost / packets received
       rttThreshold: 500, // 500 ms noticeable quality lag begins based on bandwidth of user
-      jitterThreshold: 500 // 500 ms noticeable quality lag begins based on bandwidth of user
+      jitterThreshold: 500, // 500 ms noticeable quality lag begins based on bandwidth of user
     },
     metrics: {
       // change to your client name else data will be muddled
@@ -55,30 +55,30 @@ export default {
       mqaMetricsInterval: 60000,
       // send to cisco internal MQA data automatically
       // we already send CA
-      autoSendMQA: true
+      autoSendMQA: true,
     },
     logging: {
       enable: true,
-      verboseEvents: true
+      verboseEvents: true,
     },
     resolution: {
       maxWidth: 1280,
       maxHeight: 720,
       idealWidth: 1280,
-      idealHeight: 720
+      idealHeight: 720,
     },
     screenResolution: {
       maxWidth: 1920,
       maxHeight: 1080,
       idealWidth: 1920,
-      idealHeight: 1080
+      idealHeight: 1080,
     },
     bandwidth: {
       // please note, these are the maximum bandwidth values
       // the server supports, minimums have to be tested
       audio: 64000,
       video: 4000000,
-      startBitrate: 2000
+      startBitrate: 2000,
     },
     screenFrameRate: 10,
     videoShareFrameRate: 30,
@@ -88,11 +88,15 @@ export default {
     enableRtx: true,
     receiveTranscription: false,
     enableExtmap: false,
+    enableAutomaticLLM: false,
     experimental: {
       enableMediaNegotiatedEvent: false,
       enableUnifiedMeetings: false,
       enableAdhocMeetings: false,
-      enableTurnDiscovery: false,
-    }
-  }
+      enableTurnDiscovery: true,
+    },
+    degradationPreferences: {
+      maxMacroblocksLimit: 8192,
+    },
+  },
 };