@webex/plugin-meetings 2.59.8 → 2.60.0-next.2

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,57 @@
+// 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;
+};
+
+/**
+ *
+ * @param {object} breakout
+ * @param {string} newSessionType
+ * @returns {boolean}
+ */
+export const isSessionTypeChangedFromSessionToMain = (breakout, newSessionType) => {
+  return (
+    breakout.previous('sessionType') === BREAKOUTS.SESSION_TYPES.BREAKOUT &&
+    newSessionType === BREAKOUTS.SESSION_TYPES.MAIN
+  );
+};

package/src/common/errors/no-meeting-info.ts

@@ -0,0 +1,24 @@
+import {ERROR_DICTIONARY} from '../../constants';
+
+/**
+ * Extended Error object for general parameter errors
+ */
+export default class NoMeetingInfoError extends Error {
+  code: any;
+  error: any;
+  sdkMessage: any;
+
+  /**
+   * @constructor
+   * @param {String} [message]
+   * @param {Object} [error]
+   */
+  constructor(message: string = ERROR_DICTIONARY.NO_MEETING_INFO.MESSAGE, error: any = null) {
+    super(message);
+    this.name = ERROR_DICTIONARY.NO_MEETING_INFO.NAME;
+    this.sdkMessage = ERROR_DICTIONARY.NO_MEETING_INFO.MESSAGE;
+    this.error = error;
+    this.stack = error ? error.stack : new Error().stack;
+    this.code = ERROR_DICTIONARY.NO_MEETING_INFO.CODE;
+  }
+}

package/src/common/errors/reclaim-host-role-errors.ts

@@ -0,0 +1,134 @@
+import * as MEETINGCONSTANTS from '../../constants';
+
+/**
+ * Extended Error object for reclaim host role empty or wrong key
+ */
+export class ReclaimHostEmptyWrongKeyError extends Error {
+  sdkMessage: string;
+  error: null;
+  code: number;
+
+  /**
+   *
+   * @constructor
+   * @param {String} [message]
+   * @param {Object} [error]
+   */
+  constructor(
+    message: string = MEETINGCONSTANTS.ERROR_DICTIONARY.RECLAIM_HOST_ROLE_EMPTY_OR_WRONG_KEY
+      .MESSAGE,
+    error: any = null
+  ) {
+    super(message);
+
+    if (Error.captureStackTrace) {
+      Error.captureStackTrace(this, ReclaimHostEmptyWrongKeyError);
+    }
+
+    this.name = MEETINGCONSTANTS.ERROR_DICTIONARY.RECLAIM_HOST_ROLE_EMPTY_OR_WRONG_KEY.NAME;
+    this.sdkMessage =
+      message || MEETINGCONSTANTS.ERROR_DICTIONARY.RECLAIM_HOST_ROLE_EMPTY_OR_WRONG_KEY.MESSAGE;
+    this.error = error;
+
+    this.code = MEETINGCONSTANTS.ERROR_DICTIONARY.RECLAIM_HOST_ROLE_EMPTY_OR_WRONG_KEY.CODE;
+  }
+}
+
+/**
+ * Extended Error object for reclaim host role not supported
+ */
+export class ReclaimHostNotSupportedError extends Error {
+  sdkMessage: string;
+  error: null;
+  code: number;
+
+  /**
+   *
+   * @constructor
+   * @param {String} [message]
+   * @param {Object} [error]
+   */
+  constructor(
+    message: string = MEETINGCONSTANTS.ERROR_DICTIONARY.RECLAIM_HOST_ROLE_NOT_SUPPORTED.MESSAGE,
+    error: any = null
+  ) {
+    super(message);
+
+    if (Error.captureStackTrace) {
+      Error.captureStackTrace(this, ReclaimHostNotSupportedError);
+    }
+
+    this.name = MEETINGCONSTANTS.ERROR_DICTIONARY.RECLAIM_HOST_ROLE_NOT_SUPPORTED.NAME;
+    this.sdkMessage =
+      message || MEETINGCONSTANTS.ERROR_DICTIONARY.RECLAIM_HOST_ROLE_NOT_SUPPORTED.MESSAGE;
+    this.error = error;
+
+    this.code = MEETINGCONSTANTS.ERROR_DICTIONARY.RECLAIM_HOST_ROLE_NOT_SUPPORTED.CODE;
+  }
+}
+
+/**
+ * Extended Error object for reclaim host role not allowed for other participants
+ */
+export class ReclaimHostNotAllowedError extends Error {
+  sdkMessage: string;
+  error: null;
+  code: number;
+
+  /**
+   *
+   * @constructor
+   * @param {String} [message]
+   * @param {Object} [error]
+   */
+  constructor(
+    message: string = MEETINGCONSTANTS.ERROR_DICTIONARY.RECLAIM_HOST_ROLE_NOT_ALLOWED.MESSAGE,
+    error: any = null
+  ) {
+    super(message);
+
+    if (Error.captureStackTrace) {
+      Error.captureStackTrace(this, ReclaimHostNotAllowedError);
+    }
+
+    this.name = MEETINGCONSTANTS.ERROR_DICTIONARY.RECLAIM_HOST_ROLE_NOT_ALLOWED.NAME;
+    this.sdkMessage =
+      message || MEETINGCONSTANTS.ERROR_DICTIONARY.RECLAIM_HOST_ROLE_NOT_ALLOWED.MESSAGE;
+    this.error = error;
+
+    this.code = MEETINGCONSTANTS.ERROR_DICTIONARY.RECLAIM_HOST_ROLE_NOT_ALLOWED.CODE;
+  }
+}
+
+/**
+ * Extended Error object for reclaim host role when user is host already
+ */
+export class ReclaimHostIsHostAlreadyError extends Error {
+  sdkMessage: string;
+  error: null;
+  code: number;
+
+  /**
+   *
+   * @constructor
+   * @param {String} [message]
+   * @param {Object} [error]
+   */
+  constructor(
+    message: string = MEETINGCONSTANTS.ERROR_DICTIONARY.RECLAIM_HOST_ROLE_IS_ALREADY_HOST.MESSAGE,
+    error: any = null
+  ) {
+    super(message);
+
+    if (Error.captureStackTrace) {
+      Error.captureStackTrace(this, ReclaimHostIsHostAlreadyError);
+    }
+
+    this.name = MEETINGCONSTANTS.ERROR_DICTIONARY.RECLAIM_HOST_ROLE_IS_ALREADY_HOST.NAME;
+    this.sdkMessage =
+      message || MEETINGCONSTANTS.ERROR_DICTIONARY.RECLAIM_HOST_ROLE_IS_ALREADY_HOST.MESSAGE;
+    this.error = error;
+
+    this.code = MEETINGCONSTANTS.ERROR_DICTIONARY.RECLAIM_HOST_ROLE_IS_ALREADY_HOST.CODE;
+  }
+}

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

@@ -72,13 +72,17 @@ WebExMeetingsErrors[UserNotJoinedError.CODE] = UserNotJoinedError;
  * @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'
+    );
   }
 }
 
@@ -104,22 +108,25 @@ export {UserInLobbyError};
 WebExMeetingsErrors[UserInLobbyError.CODE] = UserInLobbyError;
 
 /**
- * @class InvalidSdpError
- * @classdesc Raised whenever SDP generated via browser is invalid.
+ * @class SpaceIDDeprecatedError
+ * @classdesc Raised whenever the user passes Space ID as destination for create meeting.
  * @extends WebexMeetingsError
- * @property {number} code - 30201
- * @property {string} message - 'user is still in the lobby or not joined'
+ * @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 InvalidSdpError extends WebexMeetingsError {
-  static CODE = 30201;
+class SpaceIDDeprecatedError extends WebexMeetingsError {
+  static CODE = 30105;
 
-  constructor(message) {
-    super(InvalidSdpError.CODE, message || 'iceConnection: sdp generated is invalid');
+  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 {InvalidSdpError};
-WebExMeetingsErrors[InvalidSdpError.CODE] = InvalidSdpError;
+export {SpaceIDDeprecatedError};
+WebExMeetingsErrors[SpaceIDDeprecatedError.CODE] = SpaceIDDeprecatedError;
 
 /**
  * @class IceGatheringFailed
@@ -138,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/logs/logger-proxy.ts

@@ -1,4 +1,4 @@
-/* eslint-disable no-unused-vars */
+/* eslint-disable @typescript-eslint/no-unused-vars */
 import LoggerConfig from './logger-config';
 
 const LoggerProxy: any = {

package/src/common/logs/request.ts

@@ -32,6 +32,8 @@ export default class LogsRequest {
    */
   async uploadLogs(
     options: {
+      autoupload?: boolean;
+      locussessionid?: string;
       feedbackId?: string;
       locusId?: string;
       correlationId?: string;
@@ -40,7 +42,7 @@ export default class LogsRequest {
     } = {}
   ) {
     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}`
@@ -48,6 +50,8 @@ export default class LogsRequest {
 
     try {
       await this.webex.internal.support.submitLogs({
+        autoupload,
+        locussessionid,
         feedbackId: id,
         locusId,
         correlationId,

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: object) {
-    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;
     }

package/src/config.ts

@@ -8,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,
@@ -86,11 +80,15 @@ export default {
     enableRtx: true,
     receiveTranscription: false,
     enableExtmap: false,
+    enableAutomaticLLM: false,
+    installedOrgID: undefined,
     experimental: {
       enableMediaNegotiatedEvent: false,
       enableUnifiedMeetings: true,
       enableAdhocMeetings: true,
-      enableTurnDiscovery: true,
+    },
+    degradationPreferences: {
+      maxMacroblocksLimit: 8192,
     },
   },
 };