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

package/src/common/errors/stats.ts

@@ -1,25 +1,25 @@
-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: 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.code = ERROR_DICTIONARY.STATS.CODE;
-  }
-}
+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: 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.code = ERROR_DICTIONARY.STATS.CODE;
+  }
+}

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

@@ -1,140 +1,140 @@
-// The document would auto generate the doc for errors
-
-// 1) Error codes for Oauth, login, mercury should be separated out (Code range)
-// 2) Errors from the actual locus server or other server in case, we can use the same error code as locus and redirect it
-// 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
-import WebexMeetingsError from './webex-meetings-error';
-
-const WebExMeetingsErrors = {};
-
-/**
- * Create a {@link WebexMeetingsError} for a given code and message.
- * @private
- * @param {number} [code] - Error code
- * @param {string} [message] - Error message
- * @returns {WebexMeetingsError}
- */
-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);
-}
-
-/**
- * @class MeetingNotActiveError
- * @classdesc Raised whenever Meeting has already ended and user tries to do a action.
- * @extends WebexMeetingsError
- * @property {number} code - 30101
- * @property {string} message - 'Meeting has already Ended or not Active'
- */
-class MeetingNotActiveError extends WebexMeetingsError {
-  static CODE = 30101;
-
-  constructor() {
-    super(MeetingNotActiveError.CODE, 'Meeting has already Ended or not Active');
-  }
-}
-
-export {MeetingNotActiveError};
-WebExMeetingsErrors[MeetingNotActiveError.CODE] = MeetingNotActiveError;
-
-/**
- * @class UserNotJoinedError
- * @classdesc Raised whenever the user has already left the meeting and user tries to do a action.
- * @extends WebexMeetingsError
- * @property {number} code - 30102
- * @property {string} message - 'User has already left the meeting'
- */
-class UserNotJoinedError extends WebexMeetingsError {
-  static CODE = 30102;
-
-  constructor() {
-    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.
- * @extends WebexMeetingsError
- * @property {number} code - 30103
- * @property {string} message - 'User has not established media yet'
- */
-class NoMediaEstablishedYetError extends WebexMeetingsError {
-  static CODE = 30103;
-
-  constructor() {
-    super(NoMediaEstablishedYetError.CODE, 'User has not established media yet');
-  }
-}
-
-export {NoMediaEstablishedYetError};
-WebExMeetingsErrors[NoMediaEstablishedYetError.CODE] = NoMediaEstablishedYetError;
-
-/**
- * @class UserInLobbyError
- * @classdesc Raised whenever the user is in lobby and not joined yet.
- * @extends WebexMeetingsError
- * @property {number} code - 30104
- * @property {string} message - 'user is still in the lobby or not joined'
- */
-class UserInLobbyError extends WebexMeetingsError {
-  static CODE = 30104;
-
-  constructor() {
-    super(UserInLobbyError.CODE, 'user is still in the lobby or not joined');
-  }
-}
-
-export {UserInLobbyError};
-WebExMeetingsErrors[UserInLobbyError.CODE] = UserInLobbyError;
-
-/**
- * @class InvalidSdpError
- * @classdesc Raised whenever SDP generated via browser is invalid.
- * @extends WebexMeetingsError
- * @property {number} code - 30201
- * @property {string} message - 'user is still in the lobby or not joined'
- */
-class InvalidSdpError extends WebexMeetingsError {
-  static CODE = 30201;
-
-  constructor(message) {
-    super(InvalidSdpError.CODE, message || 'iceConnection: sdp generated is invalid');
-  }
-}
-
-export {InvalidSdpError};
-WebExMeetingsErrors[InvalidSdpError.CODE] = InvalidSdpError;
-
-/**
- * @class IceGatheringFailed
- * @classdesc Raised whenever ice gathering fails.
- * @extends WebexMeetingsError
- * @property {number} code - 30202
- * @property {string} message - 'user failed ice gathering check network/firewall'
- */
-class IceGatheringFailed extends WebexMeetingsError {
-  static CODE = 30202;
-
-  constructor() {
-    super(IceGatheringFailed.CODE, 'iceConnection: gethering ice candidate failed');
-  }
-}
-
-export {IceGatheringFailed};
-WebExMeetingsErrors[IceGatheringFailed.CODE] = IceGatheringFailed;
+// The document would auto generate the doc for errors
+
+// 1) Error codes for Oauth, login, mercury should be separated out (Code range)
+// 2) Errors from the actual locus server or other server in case, we can use the same error code as locus and redirect it
+// 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
+import WebexMeetingsError from './webex-meetings-error';
+
+const WebExMeetingsErrors = {};
+
+/**
+ * Create a {@link WebexMeetingsError} for a given code and message.
+ * @private
+ * @param {number} [code] - Error code
+ * @param {string} [message] - Error message
+ * @returns {WebexMeetingsError}
+ */
+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);
+}
+
+/**
+ * @class MeetingNotActiveError
+ * @classdesc Raised whenever Meeting has already ended and user tries to do a action.
+ * @extends WebexMeetingsError
+ * @property {number} code - 30101
+ * @property {string} message - 'Meeting has already Ended or not Active'
+ */
+class MeetingNotActiveError extends WebexMeetingsError {
+  static CODE = 30101;
+
+  constructor() {
+    super(MeetingNotActiveError.CODE, 'Meeting has already Ended or not Active');
+  }
+}
+
+export {MeetingNotActiveError};
+WebExMeetingsErrors[MeetingNotActiveError.CODE] = MeetingNotActiveError;
+
+/**
+ * @class UserNotJoinedError
+ * @classdesc Raised whenever the user has already left the meeting and user tries to do a action.
+ * @extends WebexMeetingsError
+ * @property {number} code - 30102
+ * @property {string} message - 'User has already left the meeting'
+ */
+class UserNotJoinedError extends WebexMeetingsError {
+  static CODE = 30102;
+
+  constructor() {
+    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.
+ * @extends WebexMeetingsError
+ * @property {number} code - 30103
+ * @property {string} message - 'User has not established media yet'
+ */
+class NoMediaEstablishedYetError extends WebexMeetingsError {
+  static CODE = 30103;
+
+  constructor() {
+    super(NoMediaEstablishedYetError.CODE, 'User has not established media yet');
+  }
+}
+
+export {NoMediaEstablishedYetError};
+WebExMeetingsErrors[NoMediaEstablishedYetError.CODE] = NoMediaEstablishedYetError;
+
+/**
+ * @class UserInLobbyError
+ * @classdesc Raised whenever the user is in lobby and not joined yet.
+ * @extends WebexMeetingsError
+ * @property {number} code - 30104
+ * @property {string} message - 'user is still in the lobby or not joined'
+ */
+class UserInLobbyError extends WebexMeetingsError {
+  static CODE = 30104;
+
+  constructor() {
+    super(UserInLobbyError.CODE, 'user is still in the lobby or not joined');
+  }
+}
+
+export {UserInLobbyError};
+WebExMeetingsErrors[UserInLobbyError.CODE] = UserInLobbyError;
+
+/**
+ * @class InvalidSdpError
+ * @classdesc Raised whenever SDP generated via browser is invalid.
+ * @extends WebexMeetingsError
+ * @property {number} code - 30201
+ * @property {string} message - 'user is still in the lobby or not joined'
+ */
+class InvalidSdpError extends WebexMeetingsError {
+  static CODE = 30201;
+
+  constructor(message) {
+    super(InvalidSdpError.CODE, message || 'iceConnection: sdp generated is invalid');
+  }
+}
+
+export {InvalidSdpError};
+WebExMeetingsErrors[InvalidSdpError.CODE] = InvalidSdpError;
+
+/**
+ * @class IceGatheringFailed
+ * @classdesc Raised whenever ice gathering fails.
+ * @extends WebexMeetingsError
+ * @property {number} code - 30202
+ * @property {string} message - 'user failed ice gathering check network/firewall'
+ */
+class IceGatheringFailed extends WebexMeetingsError {
+  static CODE = 30202;
+
+  constructor() {
+    super(IceGatheringFailed.CODE, 'iceConnection: gethering ice candidate failed');
+  }
+}
+
+export {IceGatheringFailed};
+WebExMeetingsErrors[IceGatheringFailed.CODE] = IceGatheringFailed;

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

@@ -1,35 +1,35 @@
-/**
- * @extends Error
- * @property {number} code - Error code
- */
-export default class WebexMeetingsError extends Error {
-  code: any;
-
-  /**
-   * Creates a new {@link WebexMeetingsError}
-   * @param {number} code - Error code
-   * @param {string} [message] - Error message
-   * @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: number, ...args: any[]) {
-    super(...args);
-
-    this.name = 'WebexMeetingsError';
-
-    Object.defineProperty(this, 'code', {
-      value: code,
-      enumerable: true,
-    });
-  }
-
-  /**
-   * Returns human readable string describing the error.
-   * @returns {string}
-   */
-  toString() {
-    const message = this.message ? `: ${this.message}` : '';
-
-    return `${this.name} ${this.code}${message}`;
-  }
-}
+/**
+ * @extends Error
+ * @property {number} code - Error code
+ */
+export default class WebexMeetingsError extends Error {
+  code: any;
+
+  /**
+   * Creates a new {@link WebexMeetingsError}
+   * @param {number} code - Error code
+   * @param {string} [message] - Error message
+   * @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: number, ...args: any[]) {
+    super(...args);
+
+    this.name = 'WebexMeetingsError';
+
+    Object.defineProperty(this, 'code', {
+      value: code,
+      enumerable: true,
+    });
+  }
+
+  /**
+   * Returns human readable string describing the error.
+   * @returns {string}
+   */
+  toString() {
+    const message = this.message ? `: ${this.message}` : '';
+
+    return `${this.name} ${this.code}${message}`;
+  }
+}

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

@@ -1,30 +1,30 @@
-import ChildEmitter from 'events';
-
-import LoggerProxy from '../logs/logger-proxy';
-import LoggerConfig from '../logs/logger-config';
-
-import EventsUtil from './util';
-
-/**
- * Events
- * plugin-meetings local
- * Used to emit events internally between modules specific to an object
- */
-export default class EventsScope extends ChildEmitter {
-  /**
-   * Emits and logs an event
-   * @param {*} scope
-   * @param {*} eventName
-   * @param {*} args
-   * @returns {Function}
-   */
-  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);
-  }
-}
+import ChildEmitter from 'events';
+
+import LoggerProxy from '../logs/logger-proxy';
+import LoggerConfig from '../logs/logger-config';
+
+import EventsUtil from './util';
+
+/**
+ * Events
+ * plugin-meetings local
+ * Used to emit events internally between modules specific to an object
+ */
+export default class EventsScope extends ChildEmitter {
+  /**
+   * Emits and logs an event
+   * @param {*} scope
+   * @param {*} eventName
+   * @param {*} args
+   * @returns {Function}
+   */
+  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.ts

@@ -1,25 +1,25 @@
-import EventEmitter from 'events';
-
-import LoggerProxy from '../logs/logger-proxy';
-import LoggerConfig from '../logs/logger-config';
-
-import EventsUtil from './util';
-
-/**
- * Events
- * plugin-meetings global
- * Used to emit events internally between modules
- */
-class Events extends EventEmitter {
-  emit(scope, eventName, args) {
-    LoggerProxy.logger.debug(
-      `${EventsUtil.getScopeLog(scope)}event#${eventName}${
-        LoggerConfig.verboseEvents ? ` -- ${EventsUtil.getEventLog(args)}` : ''
-      }`
-    );
-
-    return super.emit(eventName, args);
-  }
-}
-
-export default new Events();
+import EventEmitter from 'events';
+
+import LoggerProxy from '../logs/logger-proxy';
+import LoggerConfig from '../logs/logger-config';
+
+import EventsUtil from './util';
+
+/**
+ * Events
+ * plugin-meetings global
+ * Used to emit events internally between modules
+ */
+class Events extends EventEmitter {
+  emit(scope, eventName, args) {
+    LoggerProxy.logger.debug(
+      `${EventsUtil.getScopeLog(scope)}event#${eventName}${
+        LoggerConfig.verboseEvents ? ` -- ${EventsUtil.getEventLog(args)}` : ''
+      }`
+    );
+
+    return super.emit(eventName, args);
+  }
+}
+
+export default new Events();

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

@@ -1,25 +1,25 @@
-import LoggerProxy from '../logs/logger-proxy';
-import LoggerConfig from '../logs/logger-config';
-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.'
-    );
-  }
-
-  LoggerProxy.logger.debug(
-    `${EventsUtil.getScopeLog(scope)}event#${trigger}${
-      LoggerConfig.verboseEvents ? ` -- ${EventsUtil.getEventLog(payload)}` : ''
-    }`
-  );
-
-  return instance.trigger(trigger, payload);
-};
-
-export default TriggerProxy;
+import LoggerProxy from '../logs/logger-proxy';
+import LoggerConfig from '../logs/logger-config';
+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.'
+    );
+  }
+
+  LoggerProxy.logger.debug(
+    `${EventsUtil.getScopeLog(scope)}event#${trigger}${
+      LoggerConfig.verboseEvents ? ` -- ${EventsUtil.getEventLog(payload)}` : ''
+    }`
+  );
+
+  return instance.trigger(trigger, payload);
+};
+
+export default TriggerProxy;

package/src/common/events/util.ts

@@ -1,39 +1,39 @@
-import {inspect} from 'util';
-
-import LoggerProxy from '../logs/logger-proxy';
-
-const EventsUtil: any = {};
-
-EventsUtil.getEventLog = (args) => {
-  let argString = '';
-
-  try {
-    argString = inspect(args);
-  } catch (e) {
-    LoggerProxy.logger.warn(`Events:util#getEventLog --> ${e}`);
-  }
-
-  return argString;
-};
-
-EventsUtil.getScopeLog = (scope) => {
-  let scopeString = '';
-
-  if (scope) {
-    if (scope.file && scope.function) {
-      scopeString += `${scope.file}:${scope.function}->`;
-
-      return scopeString;
-    }
-    if (scope.file) {
-      scopeString += `${scope.file}->`;
-    }
-    if (scope.function) {
-      scopeString += `${scope.function}->`;
-    }
-  }
-
-  return scopeString;
-};
-
-export default EventsUtil;
+import {inspect} from 'util';
+
+import LoggerProxy from '../logs/logger-proxy';
+
+const EventsUtil: any = {};
+
+EventsUtil.getEventLog = (args) => {
+  let argString = '';
+
+  try {
+    argString = inspect(args);
+  } catch (e) {
+    LoggerProxy.logger.warn(`Events:util#getEventLog --> ${e}`);
+  }
+
+  return argString;
+};
+
+EventsUtil.getScopeLog = (scope) => {
+  let scopeString = '';
+
+  if (scope) {
+    if (scope.file && scope.function) {
+      scopeString += `${scope.file}:${scope.function}->`;
+
+      return scopeString;
+    }
+    if (scope.file) {
+      scopeString += `${scope.file}->`;
+    }
+    if (scope.function) {
+      scopeString += `${scope.function}->`;
+    }
+  }
+
+  return scopeString;
+};
+
+export default EventsUtil;

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

@@ -1,8 +1,8 @@
-const LoggerConfig: any = {};
-
-LoggerConfig.set = (options) => {
-  LoggerConfig.verboseEvents = options.verboseEvents;
-  LoggerConfig.enable = options.enable;
-};
-
-export default LoggerConfig;
+const LoggerConfig: any = {};
+
+LoggerConfig.set = (options) => {
+  LoggerConfig.verboseEvents = options.verboseEvents;
+  LoggerConfig.enable = options.enable;
+};
+
+export default LoggerConfig;