@webex/plugin-meetings 3.0.0-beta.4 → 3.0.0-beta.400

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,33 +57,38 @@ 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.
  * @extends WebexMeetingsError
  * @property {number} code - 30103
- * @property {string} message - 'User has not established media yet'
+ * @property {string} message - error message
  */
 class NoMediaEstablishedYetError extends WebexMeetingsError {
   static CODE = 30103;
 
+  // eslint-disable-next-line require-jsdoc
   constructor() {
-    super(NoMediaEstablishedYetError.CODE, 'User has not established media yet');
+    super(
+      NoMediaEstablishedYetError.CODE,
+      'Webrtc media connection is missing, call addMedia() first'
+    );
   }
 }
 
 export {NoMediaEstablishedYetError};
 WebExMeetingsErrors[NoMediaEstablishedYetError.CODE] = NoMediaEstablishedYetError;
 
-
 /**
  * @class UserInLobbyError
  * @classdesc Raised whenever the user is in lobby and not joined yet.
@@ -101,6 +107,26 @@ class UserInLobbyError extends WebexMeetingsError {
 export {UserInLobbyError};
 WebExMeetingsErrors[UserInLobbyError.CODE] = UserInLobbyError;
 
+/**
+ * @class SpaceIDDeprecatedError
+ * @classdesc Raised whenever the user passes Space ID as destination for create meeting.
+ * @extends WebexMeetingsError
+ * @property {number} code - 30105
+ * @property {string} message - 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.'
+ */
+class SpaceIDDeprecatedError extends WebexMeetingsError {
+  static CODE = 30105;
+
+  constructor() {
+    super(
+      SpaceIDDeprecatedError.CODE,
+      '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.'
+    );
+  }
+}
+
+export {SpaceIDDeprecatedError};
+WebExMeetingsErrors[SpaceIDDeprecatedError.CODE] = SpaceIDDeprecatedError;
 
 /**
  * @class IceGatheringFailed
@@ -119,3 +145,20 @@ class IceGatheringFailed extends WebexMeetingsError {
 
 export {IceGatheringFailed};
 WebExMeetingsErrors[IceGatheringFailed.CODE] = IceGatheringFailed;
+
+/**
+ * @class AddMediaFailed
+ * @classdesc Raised whenever we fail to successfully add media to a meeting
+ * @extends WebexMeetingsError
+ * @property {number} code - 30203
+ * @property {string} message - 'Failed to add media'
+ */
+class AddMediaFailed extends WebexMeetingsError {
+  static CODE = 30203;
+
+  constructor() {
+    super(AddMediaFailed.CODE, 'Failed to add media');
+  }
+}
+export {AddMediaFailed};
+WebExMeetingsErrors[AddMediaFailed.CODE] = AddMediaFailed;

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;

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

@@ -0,0 +1,44 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+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');
+    },
+  },
+};
+
+LoggerProxy.set = (logger) => {
+  if (!LoggerConfig.enable) {
+    LoggerProxy.logger = {
+      info: () => {},
+      log: () => {},
+      error: () => {},
+      warn: () => {},
+      trace: () => {},
+      debug: () => {},
+    };
+  } else {
+    LoggerProxy.logger = logger;
+  }
+};
+
+LoggerProxy.get = () => LoggerProxy.logger;
+
+export default LoggerProxy;

package/src/common/logs/{request.js → request.ts}

@@ -6,13 +6,15 @@ import LoggerProxy from './logger-proxy';
  * @class LogsRequest
  */
 export default class LogsRequest {
+  webex: any;
+
   /**
    *
    * @param {Object} options
    * @param {Object} options.webex Webex SDK instance
    * @param {ClientMetrics} metrics
    */
-  constructor(options) {
+  constructor(options: {webex: object}) {
     this.webex = options.webex;
   }
 
@@ -28,20 +30,35 @@ export default class LogsRequest {
    * @returns {Promise.<String>} Feedback ID
    * @memberof LogsRequest
    */
-  async uploadLogs(options = {}) {
+  async uploadLogs(
+    options: {
+      autoupload?: boolean;
+      locussessionid?: string;
+      feedbackId?: string;
+      locusId?: string;
+      correlationId?: string;
+      callStart?: string;
+      meetingId?: string;
+    } = {}
+  ) {
     const id = options.feedbackId || uuid.v4();
-    const {
-      locusId, correlationId, meetingId, callStart
-    } = options;
+    const {locusId, correlationId, meetingId, callStart, locussessionid, autoupload} = 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
+        autoupload,
+        locussessionid,
+        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/common/queue.ts

@@ -1,13 +1,18 @@
 /**
- * Simple queue
+ * Simple queue in which the elements are always sorted
  */
-export default class SimpleQueue {
-  queue: any[];
+export default class SortedQueue<ItemType> {
+  queue: ItemType[];
+  // returns -1 if left < right, 0 if left === right, +1 if left > right
+  compareFunc: (left: ItemType, right: ItemType) => number;
+
   /**
-   * @constructs SimpleQueue
+   * @constructs SortedQueue
+   * @param {Function} compareFunc comparison function used for sorting the elements of the queue
    */
-  constructor() {
+  constructor(compareFunc: (left: ItemType, right: ItemType) => number) {
     this.queue = [];
+    this.compareFunc = compareFunc;
   }
 
   /**
@@ -23,8 +28,17 @@ export default class SimpleQueue {
    * @param {object} item
    * @returns {undefined}
    */
-  enqueue(item) {
-    this.queue.push(item);
+  enqueue(item: ItemType) {
+    // Find the index of the first item in the queue that's greater or equal to the new item.
+    // That's where we want to insert the new item.
+    const idx = this.queue.findIndex((existingItem) => {
+      return this.compareFunc(existingItem, item) >= 0;
+    });
+    if (idx >= 0) {
+      this.queue.splice(idx, 0, item);
+    } else {
+      this.queue.push(item);
+    }
   }
 
   /**
@@ -32,7 +46,7 @@ export default class SimpleQueue {
    * Returns null if the queue is empty.
    * @returns {(object|null)} Queue item or null.
    */
-  dequeue() {
+  dequeue(): ItemType {
     if (this.queue.length === 0) {
       return null;
     }
@@ -48,4 +62,3 @@ export default class SimpleQueue {
     return this.queue.length;
   }
 }
-

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

@@ -1,6 +1,5 @@
-import {
-  deviceType
-} from '@webex/common';
+// @ts-ignore
+import {deviceType} from '@webex/common';
 
 export default {
   // TODO: this needs to be defaulted
@@ -9,13 +8,7 @@ export default {
   meetings: {
     deviceType: deviceType.WEB,
     mediaSettings: {
-      sendAudio: true,
-      sendVideo: true,
-      receiveAudio: true,
-      receiveVideo: true,
       pstn: false,
-      sendShare: false,
-      receiveShare: false
     },
     reconnection: {
       enabled: false,
@@ -24,7 +17,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
@@ -40,7 +33,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
@@ -54,30 +47,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,
@@ -87,11 +80,16 @@ export default {
     enableRtx: true,
     receiveTranscription: false,
     enableExtmap: false,
+    enableAutomaticLLM: false,
+    installedOrgID: undefined,
     experimental: {
       enableMediaNegotiatedEvent: false,
-      enableUnifiedMeetings: false,
-      enableAdhocMeetings: false,
-      enableTurnDiscovery: false,
-    }
-  }
+      enableUnifiedMeetings: true,
+      enableAdhocMeetings: true,
+      enableTcpReachability: false,
+    },
+    degradationPreferences: {
+      maxMacroblocksLimit: 8192,
+    },
+  },
 };