@webex/plugin-meetings 3.0.0-beta.167 → 3.0.0-beta.169

package/dist/types/index.d.ts

@@ -1,5 +1,5 @@
 import Meetings from './meetings';
-export { getDevices, LocalTrack, LocalDisplayTrack, LocalTrackEvents, type TrackMuteEvent, type ServerMuteReason, LocalMicrophoneTrackEvents, LocalCameraTrackEvents, LocalMicrophoneTrack, LocalCameraTrack, createMicrophoneTrack, createCameraTrack, createDisplayTrack, } from '@webex/media-helpers';
+export { getDevices, LocalTrack, LocalDisplayTrack, LocalTrackEvents, type TrackMuteEvent, type ServerMuteReason, LocalMicrophoneTrackEvents, LocalCameraTrackEvents, LocalMicrophoneTrack, LocalCameraTrack, createMicrophoneTrack, createCameraTrack, createDisplayTrack, FacingMode, DisplaySurface, PresetCameraConstraints, } from '@webex/media-helpers';
 export default Meetings;
 export * as CONSTANTS from './constants';
 export * as REACTIONS from './reactions/reactions';

package/dist/types/meeting/index.d.ts

@@ -36,6 +36,7 @@ export type AddMediaOptions = {
     receiveShare?: boolean;
     remoteMediaManagerConfig?: RemoteMediaManagerConfiguration;
     bundlePolicy?: BundlePolicy;
+    allowMediaInLobby?: boolean;
 };
 export declare const MEDIA_UPDATE_TYPE: {
     TRANSCODED_MEDIA_CONNECTION: string;
@@ -875,7 +876,7 @@ export default class Meeting extends StatelessWebexPlugin {
      * Shorthand function to join AND set up media
      * @param {Object} options - options to join with media
      * @param {JoinOptions} [options.joinOptions] - see #join()
-     * @param {MediaDirection} [options.mediaOptions] - see #addMedia()
+     * @param {AddMediaOptions} [options.mediaOptions] - see #addMedia()
      * @returns {Promise} -- {join: see join(), media: see addMedia()}
      * @public
      * @memberof Meeting

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webex/plugin-meetings",
-  "version": "3.0.0-beta.167",
+  "version": "3.0.0-beta.169",
   "description": "",
   "license": "Cisco EULA (https://www.cisco.com/c/en/us/products/end-user-license-agreement.html)",
   "contributors": [
@@ -32,12 +32,12 @@
     "build": "yarn run -T tsc --declaration true --declarationDir ./dist/types"
   },
   "devDependencies": {
-    "@webex/plugin-meetings": "3.0.0-beta.167",
-    "@webex/test-helper-chai": "3.0.0-beta.167",
-    "@webex/test-helper-mocha": "3.0.0-beta.167",
-    "@webex/test-helper-mock-webex": "3.0.0-beta.167",
-    "@webex/test-helper-retry": "3.0.0-beta.167",
-    "@webex/test-helper-test-users": "3.0.0-beta.167",
+    "@webex/plugin-meetings": "3.0.0-beta.169",
+    "@webex/test-helper-chai": "3.0.0-beta.169",
+    "@webex/test-helper-mocha": "3.0.0-beta.169",
+    "@webex/test-helper-mock-webex": "3.0.0-beta.169",
+    "@webex/test-helper-retry": "3.0.0-beta.169",
+    "@webex/test-helper-test-users": "3.0.0-beta.169",
     "chai": "^4.3.4",
     "chai-as-promised": "^7.1.1",
     "jsdom-global": "3.0.2",
@@ -46,19 +46,19 @@
     "typescript": "^4.7.4"
   },
   "dependencies": {
-    "@webex/common": "3.0.0-beta.167",
+    "@webex/common": "3.0.0-beta.169",
     "@webex/internal-media-core": "1.38.6",
-    "@webex/internal-plugin-conversation": "3.0.0-beta.167",
-    "@webex/internal-plugin-device": "3.0.0-beta.167",
-    "@webex/internal-plugin-llm": "3.0.0-beta.167",
-    "@webex/internal-plugin-mercury": "3.0.0-beta.167",
-    "@webex/internal-plugin-metrics": "3.0.0-beta.167",
-    "@webex/internal-plugin-support": "3.0.0-beta.167",
-    "@webex/internal-plugin-user": "3.0.0-beta.167",
-    "@webex/media-helpers": "3.0.0-beta.167",
-    "@webex/plugin-people": "3.0.0-beta.167",
-    "@webex/plugin-rooms": "3.0.0-beta.167",
-    "@webex/webex-core": "3.0.0-beta.167",
+    "@webex/internal-plugin-conversation": "3.0.0-beta.169",
+    "@webex/internal-plugin-device": "3.0.0-beta.169",
+    "@webex/internal-plugin-llm": "3.0.0-beta.169",
+    "@webex/internal-plugin-mercury": "3.0.0-beta.169",
+    "@webex/internal-plugin-metrics": "3.0.0-beta.169",
+    "@webex/internal-plugin-support": "3.0.0-beta.169",
+    "@webex/internal-plugin-user": "3.0.0-beta.169",
+    "@webex/media-helpers": "3.0.0-beta.169",
+    "@webex/plugin-people": "3.0.0-beta.169",
+    "@webex/plugin-rooms": "3.0.0-beta.169",
+    "@webex/webex-core": "3.0.0-beta.169",
     "ampersand-collection": "^2.0.2",
     "bowser": "^2.11.0",
     "btoa": "^1.2.1",

package/src/breakouts/breakout.ts

@@ -68,7 +68,7 @@ const Breakout = WebexPlugin.extend({
     breakoutEvent.onBreakoutMoveRequest(
       {currentSession: this, meeting, breakoutMoveId},
       // @ts-ignore
-      this.webex.internal.newMetrics.submitClientEvent
+      this.webex.internal.newMetrics.submitClientEvent.bind(this.webex.internal.newMetrics)
     );
     const result = await this.request({
       method: HTTP_VERBS.POST,
@@ -83,7 +83,7 @@ const Breakout = WebexPlugin.extend({
     breakoutEvent.onBreakoutMoveResponse(
       {currentSession: this, meeting, breakoutMoveId},
       // @ts-ignore
-      this.webex.internal.newMetrics.submitClientEvent
+      this.webex.internal.newMetrics.submitClientEvent.bind(this.webex.internal.newMetrics)
     );
 
     return result;

package/src/breakouts/index.ts

@@ -356,7 +356,7 @@ const Breakouts = WebexPlugin.extend({
           breakoutMoveId: params.breakoutMoveId,
         },
         // @ts-ignore
-        this.webex.internal.newMetrics.submitClientEvent
+        this.webex.internal.newMetrics.submitClientEvent.bind(this.webex.internal.newMetrics)
       );
     }
   },

package/src/index.ts

@@ -22,6 +22,9 @@ export {
   createMicrophoneTrack,
   createCameraTrack,
   createDisplayTrack,
+  FacingMode,
+  DisplaySurface,
+  PresetCameraConstraints,
 } from '@webex/media-helpers';
 
 export default Meetings;

package/src/meeting/index.ts

@@ -157,6 +157,7 @@ export type AddMediaOptions = {
   receiveShare?: boolean; // if not specified, default value true is used
   remoteMediaManagerConfig?: RemoteMediaManagerConfiguration; // applies only to multistream meetings
   bundlePolicy?: BundlePolicy; // applies only to multistream meetings
+  allowMediaInLobby?: boolean; // allows adding media when in the lobby
 };
 
 export const MEDIA_UPDATE_TYPE = {
@@ -3698,7 +3699,7 @@ export default class Meeting extends StatelessWebexPlugin {
    * Shorthand function to join AND set up media
    * @param {Object} options - options to join with media
    * @param {JoinOptions} [options.joinOptions] - see #join()
-   * @param {MediaDirection} [options.mediaOptions] - see #addMedia()
+   * @param {AddMediaOptions} [options.mediaOptions] - see #addMedia()
    * @returns {Promise} -- {join: see join(), media: see addMedia()}
    * @public
    * @memberof Meeting
@@ -5133,11 +5134,6 @@ export default class Meeting extends StatelessWebexPlugin {
     if (MeetingUtil.isUserInLeftState(this.locusInfo)) {
       return Promise.reject(new UserNotJoinedError());
     }
-    // If the user is unjoined or guest waiting in lobby dont allow the user to addMedia
-    // @ts-ignore - isUserUnadmitted coming from SelfUtil
-    if (this.isUserUnadmitted && !this.wirelessShare) {
-      return Promise.reject(new UserInLobbyError());
-    }
 
     const {
       localTracks,
@@ -5146,8 +5142,15 @@ export default class Meeting extends StatelessWebexPlugin {
       receiveShare = true,
       remoteMediaManagerConfig,
       bundlePolicy,
+      allowMediaInLobby,
     } = options;
 
+    // If the user is unjoined or guest waiting in lobby dont allow the user to addMedia
+    // @ts-ignore - isUserUnadmitted coming from SelfUtil
+    if (this.isUserUnadmitted && !this.wirelessShare && !allowMediaInLobby) {
+      return Promise.reject(new UserInLobbyError());
+    }
+
     // @ts-ignore
     this.webex.internal.newMetrics.submitClientEvent({
       name: 'client.media.capabilities',

package/test/unit/spec/breakouts/breakout.ts

@@ -89,6 +89,8 @@ describe('plugin-meetings', () => {
         })
         };
 
+        sinon.stub(webex.internal.newMetrics.submitClientEvent, 'bind').returns(webex.internal.newMetrics.submitClientEvent);
+
         let onBreakoutMoveRequestStub = sinon.stub(breakoutEvent, 'onBreakoutMoveRequest');
         let onBreakoutMoveResponseStub = sinon.stub(breakoutEvent, 'onBreakoutMoveResponse');
         await breakout.join();

package/test/unit/spec/breakouts/events.ts

@@ -49,6 +49,8 @@ describe('plugin-meetings', () => {
       it('send metric as expected', () => {
         const submitClientEvent = sinon.stub();
 
+        sinon.stub(submitClientEvent, 'bind').returns(webex.internal.newMetrics.submitClientEvent);
+
         breakoutEvent.postMoveCallAnalyzer = sinon.stub();
         const eventInfo = {newSession, mockMeeting, breakoutMoveId};
         breakoutEvent.onBreakoutMoveRequest(eventInfo, submitClientEvent);
@@ -61,6 +63,8 @@ describe('plugin-meetings', () => {
       it('send metric as expected', () => {
         const submitClientEvent = sinon.stub();
 
+        sinon.stub(submitClientEvent, 'bind').returns(webex.internal.newMetrics.submitClientEvent);
+
         breakoutEvent.postMoveCallAnalyzer = sinon.stub();
         const eventInfo = {newSession, mockMeeting, breakoutMoveId};
         breakoutEvent.onBreakoutMoveResponse(eventInfo, submitClientEvent);
@@ -72,6 +76,8 @@ describe('plugin-meetings', () => {
       it('send metric as expected', () => {
         const submitClientEvent = sinon.stub();
 
+        sinon.stub(submitClientEvent, 'bind').returns(webex.internal.newMetrics.submitClientEvent);
+
         breakoutEvent.postMoveCallAnalyzer = sinon.stub();
         const eventInfo = {newSession, mockMeeting, breakoutMoveId};
         breakoutEvent.onBreakoutJoinResponse(eventInfo, submitClientEvent);

package/test/unit/spec/meeting/index.js

@@ -484,19 +484,29 @@ describe('plugin-meetings', () => {
       });
 
       describe('#joinWithMedia', () => {
+
         it('should have #joinWithMedia', () => {
           assert.exists(meeting.joinWithMedia);
         });
+
         describe('resolution', () => {
           it('should success and return a promise', async () => {
             meeting.join = sinon.stub().returns(Promise.resolve(test1));
             meeting.addMedia = sinon.stub().returns(Promise.resolve(test4));
-            const result = await meeting.joinWithMedia({});
-            assert.calledOnce(meeting.join);
-            assert.calledOnce(meeting.addMedia);
+
+            const joinOptions = {correlationId: '12345'};
+            const mediaOptions = {audioEnabled: test1, allowMediaInLobby: true};
+
+            const result = await meeting.joinWithMedia({
+              joinOptions,
+              mediaOptions,
+            });
+            assert.calledOnceWithExactly(meeting.join, joinOptions);
+            assert.calledOnceWithExactly(meeting.addMedia, mediaOptions);
             assert.deepEqual(result, {join: test1, media: test4});
           });
         });
+
         describe('rejection', () => {
           it('should error out and return a promise', async () => {
             meeting.join = sinon.stub().returns(Promise.reject());
@@ -821,6 +831,7 @@ describe('plugin-meetings', () => {
           });
         });
       });
+
       describe('#addMedia', () => {
         const muteStateStub = {
           handleClientRequest: sinon.stub().returns(Promise.resolve(true)),
@@ -1106,18 +1117,7 @@ describe('plugin-meetings', () => {
           });
         });
 
-        it('should attach the media and return promise', async () => {
-          meeting.roap.doTurnDiscovery = sinon
-            .stub()
-            .resolves({turnServerInfo: undefined, turnDiscoverySkippedReason: undefined});
-
-          meeting.meetingState = 'ACTIVE';
-          const media = meeting.addMedia({
-            mediaSettings: {},
-          });
-
-          assert.exists(media);
-          await media;
+        const checkWorking = () => {
           assert.calledOnce(meeting.roap.doTurnDiscovery);
           assert.calledWith(meeting.roap.doTurnDiscovery, meeting, false);
           assert.calledOnce(meeting.mediaProperties.setMediaDirection);
@@ -1130,9 +1130,40 @@ describe('plugin-meetings', () => {
           );
           assert.calledOnce(meeting.setMercuryListener);
           assert.calledOnce(fakeMediaConnection.initiateOffer);
-          /* statsAnalyzer is initiated inside of addMedia so there isn't
-           * a good way to mock it without mocking the constructor
-           */
+        }
+
+        it('should attach the media and return promise', async () => {
+          meeting.roap.doTurnDiscovery = sinon
+            .stub()
+            .resolves({turnServerInfo: undefined, turnDiscoverySkippedReason: undefined});
+
+          meeting.meetingState = 'ACTIVE';
+          const media = meeting.addMedia({
+            mediaSettings: {},
+          });
+
+          assert.exists(media);
+          await media;
+
+          checkWorking();
+        });
+
+        it('should attach the media and return promise when in the lobby if allowMediaInLobby is set', async () => {
+          meeting.roap.doTurnDiscovery = sinon
+            .stub()
+            .resolves({turnServerInfo: undefined, turnDiscoverySkippedReason: undefined});
+
+          meeting.meetingState = 'ACTIVE';
+          meeting.locusInfo.parsedLocus = {self: {state: 'IDLE'}};
+          meeting.isUserUnadmitted = true;
+          const media = meeting.addMedia({
+            allowMediaInLobby: true,
+          });
+
+          assert.exists(media);
+          await media;
+
+          checkWorking();
         });
 
         it('should pass the turn server info to the peer connection', async () => {