@webex/plugin-meetings 3.0.0-beta.7 → 3.0.0-beta.71

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.js → 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) => (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

@@ -13,7 +13,7 @@ export default class Collection {
    * @param {String} property
    * @memberof Collection
    */
-  constructor(property) {
+  constructor(property: string) {
     if (!property || !isString(property)) {
       throw new ParameterError('Collection expects a string to use as a property name.');
     }
@@ -41,8 +41,10 @@ export default class Collection {
    * @public
    * @memberof Collection
    */
-  get(id) {
-    return this[this.propertyName] && this[this.propertyName][id] ? this[this.propertyName][id] : null;
+  public get(id: string) {
+    return this[this.propertyName] && this[this.propertyName][id]
+      ? this[this.propertyName][id]
+      : null;
   }
 
   /**
@@ -52,7 +54,7 @@ export default class Collection {
    * @public
    * @memberof Collection
    */
-  set(id, value) {
+  public set(id: string, value: any) {
     this[this.propertyName][id] = value;
 
     return this.get(id);
@@ -65,7 +67,7 @@ export default class Collection {
    * @public
    * @memberof Collection
    */
-  delete(id) {
+  public delete(id: string) {
     delete this[this.propertyName][id];
   }
 
@@ -74,7 +76,7 @@ export default class Collection {
    * @public
    * @memberof Collection
    */
-  getAll() {
+  public getAll() {
     return this[this.propertyName];
   }
 
@@ -84,7 +86,7 @@ export default class Collection {
    * @public
    * @memberof Collection
    */
-  setAll(set) {
+  public setAll(set: object) {
     this[this.propertyName] = set;
 
     return this.getAll();

package/src/common/{config.js → config.ts}

@@ -1,4 +1,4 @@
-const StaticConfig = {};
+const StaticConfig: any = {};
 
 StaticConfig.set = (options) => {
   const values = {};

package/src/common/errors/{captcha-error.js → captcha-error.ts}

@@ -4,18 +4,22 @@ import {ERROR_DICTIONARY} from '../../constants';
  * Extended Error object to signify captcha related errors
  */
 export default class CaptchaError extends Error {
+  code: any;
+  error: any;
+  sdkMessage: any;
+
   /**
-  *
-  * @constructor
-  * @param {String} [message]
-  * @param {Object} [error]
-  */
-  constructor(message = ERROR_DICTIONARY.CAPTCHA.MESSAGE, error = null) {
+   *
+   * @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.js → intent-to-join.ts}

@@ -4,18 +4,23 @@ import {ERROR_DICTIONARY} from '../../constants';
  * Extended Error object to signify the intent to join for unclaimed PMR scenarios
  */
 export default class IntentToJoinError extends Error {
+  code: any;
+  error: any;
+  joinIntentRequired: any;
+  sdkMessage: any;
+
   /**
-  *
-  * @constructor
-  * @param {String} [message]
-  * @param {Object} [error]
-  */
-  constructor(message = ERROR_DICTIONARY.INTENT_TO_JOIN.MESSAGE, error = null) {
+   *
+   * @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.js → join-meeting.ts}

@@ -4,19 +4,28 @@ import {ERROR_DICTIONARY} from '../../constants';
  * Extended Error object to signify a join meeting error
  */
 export default class JoinMeetingError extends Error {
+  code: any;
+  error: any;
+  joinOptions: any;
+  sdkMessage: any;
+
   /**
-  *
-  * @constructor
-  * @param {Object} [options]
-  * @param {String} [message]
-  * @param {Object} [error]
-  */
-  constructor(options = {}, message = ERROR_DICTIONARY.JOIN_MEETING.MESSAGE, error = 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.js → media.ts}

@@ -4,18 +4,22 @@ import {ERROR_DICTIONARY} from '../../constants';
  * Extended Error object for media errors
  */
 export default class MediaError extends Error {
+  code: any;
+  error: any;
+  sdkMessage: any;
+
   /**
-  *
-  * @constructor
-  * @param {String} [message]
-  * @param {Object} [error]
-  */
-  constructor(message = ERROR_DICTIONARY.MEDIA.MESSAGE, error = null) {
+   *
+   * @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

@@ -1,4 +1,4 @@
-import * as MEETINGCONSTANTS  from '../../constants';
+import * as MEETINGCONSTANTS from '../../constants';
 
 /**
  * Extended Error object for general parameter errors
@@ -7,13 +7,17 @@ export default class ParameterError extends Error {
   sdkMessage: string;
   error: null;
   code: number;
+
   /**
-  *
-  * @constructor
-  * @param {String} [message]
-  * @param {Object} [error]
-  */
-  constructor(message = MEETINGCONSTANTS.ERROR_DICTIONARY.PARAMETER.MESSAGE, error = 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.js → password-error.ts}

@@ -4,18 +4,22 @@ import {ERROR_DICTIONARY} from '../../constants';
  * Extended Error object to signify password related errors
  */
 export default class PasswordError extends Error {
+  code: any;
+  error: any;
+  sdkMessage: any;
+
   /**
-  *
-  * @constructor
-  * @param {String} [message]
-  * @param {Object} [error]
-  */
-  constructor(message = ERROR_DICTIONARY.PASSWORD.MESSAGE, error = null) {
+   *
+   * @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.js → permission.ts}

@@ -4,17 +4,21 @@ import {ERROR_DICTIONARY} from '../../constants';
  * Extended Error object for general parameter errors
  */
 export default class PermissionError extends Error {
+  code: any;
+  error: any;
+  sdkMessage: any;
+
   /**
-  * @constructor
-  * @param {String} [message]
-  * @param {Object} [error]
-  */
-  constructor(message = ERROR_DICTIONARY.PERMISSION.MESSAGE, error = null) {
+   * @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.js → reconnection.ts}

@@ -4,18 +4,22 @@ import {ERROR_DICTIONARY} from '../../constants';
  * Extended Error object to signify the intent to join for unclaimed PMR scenarios
  */
 export default class ReconnectionError extends Error {
+  code: any;
+  error: any;
+  sdkMessage: any;
+
   /**
-  *
-  * @constructor
-  * @param {String} [message]
-  * @param {Object} [error]
-  */
-  constructor(message = ERROR_DICTIONARY.RECONNECTION.MESSAGE, error = null) {
+   *
+   * @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.js → stats.ts}

@@ -4,18 +4,22 @@ import {ERROR_DICTIONARY} from '../../constants';
  * Extended Error object for Stats Errors
  */
 export default class StatsError extends Error {
+  code: any;
+  error: any;
+  sdkMessage: any;
+
   /**
-  *
-  * @constructor
-  * @param {String} [message]
-  * @param {Object} [error]
-  */
-  constructor(message = ERROR_DICTIONARY.STATS.MESSAGE, error = null) {
+   *
+   * @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.js → webex-errors.ts}

@@ -5,7 +5,6 @@
 // 3) Any errors we generate from the SDK can be split into various categories
 // Parameter validation, user action, connection, media specific(They can have different range)
 
-
 // TODO: all the errors from the server need to be captured
 
 // add a way to log and send metrics if needed
@@ -20,11 +19,13 @@ const WebExMeetingsErrors = {};
  * @param {string} [message] - Error message
  * @returns {WebexMeetingsError}
  */
-export function createMeetingsError(code, message) {
+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);
 }
 
 /**
@@ -56,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.
@@ -82,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.
@@ -101,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.js → webex-meetings-error.ts}

@@ -3,6 +3,8 @@
  * @property {number} code - Error code
  */
 export default class WebexMeetingsError extends Error {
+  code: any;
+
   /**
    * Creates a new {@link WebexMeetingsError}
    * @param {number} code - Error code
@@ -10,14 +12,14 @@ export default class WebexMeetingsError extends Error {
    * @param {string} [fileName] - Name of the script file where error was generated
    * @param {number} [lineNumber] - Line number of the script file where error was generated
    */
-  constructor(code, ...args) {
+  constructor(code: number, ...args: any[]) {
     super(...args);
 
     this.name = 'WebexMeetingsError';
 
     Object.defineProperty(this, 'code', {
       value: code,
-      enumerable: true
+      enumerable: true,
     });
   }
 

package/src/common/events/{events-scope.js → events-scope.ts}

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

package/src/common/events/{events.js → 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.js → trigger-proxy.ts}

@@ -1,19 +1,23 @@
-
 import LoggerProxy from '../logs/logger-proxy';
 import LoggerConfig from '../logs/logger-config';
 import ParameterError from '../errors/parameter';
 
 import EventsUtil from './util';
 
-
-const TriggerProxy = {};
+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.js → util.ts}

@@ -2,15 +2,14 @@ import {inspect} from 'util';
 
 import LoggerProxy from '../logs/logger-proxy';
 
-const EventsUtil = {};
+const EventsUtil: any = {};
 
 EventsUtil.getEventLog = (args) => {
   let argString = '';
 
   try {
     argString = inspect(args);
-  }
-  catch (e) {
+  } catch (e) {
     LoggerProxy.logger.warn(`Events:util#getEventLog --> ${e}`);
   }
 

package/src/common/logs/{logger-config.js → logger-config.ts}

@@ -1,5 +1,4 @@
-
-const LoggerConfig = {};
+const LoggerConfig: any = {};
 
 LoggerConfig.set = (options) => {
   LoggerConfig.verboseEvents = options.verboseEvents;