@webex/plugin-meetings 3.8.0-next.59 → 3.8.0-next.60

package/dist/types/members/request.d.ts

@@ -53,6 +53,25 @@ export default class MembersRequest extends StatelessWebexPlugin {
      * @returns {Promise}
      */
     assignRolesMember(options: any): Promise<any>;
+    /**
+     * Sends a request to move a meeting member into the lobby.
+     * *
+     * @param {Object} options - Request options.
+     * @param {string} options.locusUrl - The locus URL for the meeting.
+     * @param {string} options.memberId - The ID of the member to move.
+     * @param {Object} body - The request payload.
+     * @param {Object} body.moveToLobby - Container for move‐to‐lobby data.
+     * @param {string[]} body.moveToLobby.participantIds - Array of participant IDs to move.
+     * @returns {Promise} - Resolves with the locus‐delta response.
+     */
+    moveToLobbyMember(options: {
+        locusUrl: string;
+        memberId: string;
+    }, body: {
+        moveToLobby: {
+            participantIds: string[];
+        };
+    }): Promise<any>;
     /**
      * Sends a request to raise or lower a member's hand
      * @param {Object} options

package/dist/types/members/util.d.ts

@@ -124,6 +124,19 @@ declare const MembersUtil: {
             };
         };
     };
+    getMoveMemberToLobbyRequestBody: (memberId: string) => {
+        moveToLobby: {
+            participantIds: string[];
+        };
+    };
+    getMoveMemberToLobbyRequestParams: (options: {
+        memberId: string;
+        locusUrl: string;
+    }, body: any) => {
+        method: string;
+        uri: string;
+        body: any;
+    };
     /**
      * @param {ServerRoleShape} role
      * @returns {ServerRoleShape} the role shape to be added to the body

package/dist/webinar/index.js

@@ -458,7 +458,7 @@ var Webinar = _webexCore.WebexPlugin.extend({
       }, _callee7);
     }))();
   },
-  version: "3.8.0-next.59"
+  version: "3.8.0-next.60"
 });
 var _default = exports.default = Webinar;
 //# sourceMappingURL=index.js.map

package/package.json

@@ -43,7 +43,7 @@
     "@webex/eslint-config-legacy": "0.0.0",
     "@webex/jest-config-legacy": "0.0.0",
     "@webex/legacy-tools": "0.0.0",
-    "@webex/plugin-meetings": "3.8.0-next.59",
+    "@webex/plugin-meetings": "3.8.0-next.60",
     "@webex/plugin-rooms": "3.8.0-next.21",
     "@webex/test-helper-chai": "3.8.0-next.17",
     "@webex/test-helper-mocha": "3.8.0-next.17",
@@ -71,7 +71,7 @@
     "@webex/internal-plugin-metrics": "3.8.0-next.17",
     "@webex/internal-plugin-support": "3.8.0-next.21",
     "@webex/internal-plugin-user": "3.8.0-next.17",
-    "@webex/internal-plugin-voicea": "3.8.0-next.59",
+    "@webex/internal-plugin-voicea": "3.8.0-next.60",
     "@webex/media-helpers": "3.8.0-next.21",
     "@webex/plugin-people": "3.8.0-next.19",
     "@webex/plugin-rooms": "3.8.0-next.21",
@@ -92,5 +92,5 @@
   "//": [
     "TODO: upgrade jwt-decode when moving to node 18"
   ],
-  "version": "3.8.0-next.59"
+  "version": "3.8.0-next.60"
 }

package/src/constants.ts

@@ -978,6 +978,7 @@ export const DISPLAY_HINTS = {
   PRESENTER_CONTROL: 'PRESENTER_CONTROL',
   CAN_RENAME_SELF_AND_OBSERVED: 'CAN_RENAME_SELF_AND_OBSERVED',
   CAN_RENAME_OTHERS: 'CAN_RENAME_OTHERS',
+  MOVE_TO_LOBBY: 'MOVE_TO_LOBBY',
 
   // breakout session
   BREAKOUT_MANAGEMENT: 'BREAKOUT_MANAGEMENT',

package/src/meeting/in-meeting-actions.ts

@@ -104,6 +104,7 @@ interface IInMeetingActions {
   canDisableAnnotation?: boolean;
   canEnableRemoteDesktopControl?: boolean;
   canDisableRemoteDesktopControl?: boolean;
+  canMoveToLobby?: boolean;
 }
 
 /**
@@ -300,6 +301,8 @@ export default class InMeetingActions implements IInMeetingActions {
 
   canDisableRemoteDesktopControl = null;
 
+  canMoveToLobby = null;
+
   /**
    * Returns all meeting action options
    * @returns {Object}
@@ -399,6 +402,7 @@ export default class InMeetingActions implements IInMeetingActions {
     canDisableAnnotation: this.canDisableAnnotation,
     canEnableRemoteDesktopControl: this.canEnableRemoteDesktopControl,
     canDisableRemoteDesktopControl: this.canDisableRemoteDesktopControl,
+    canMoveToLobby: this.canMoveToLobby,
   });
 
   /**

package/src/meeting/index.ts

@@ -4126,6 +4126,7 @@ export default class Meeting extends StatelessWebexPlugin {
             this.userDisplayHints
           ),
           canUserRenameOthers: MeetingUtil.canUserRenameOthers(this.userDisplayHints),
+          canMoveToLobby: MeetingUtil.canMoveToLobby(this.userDisplayHints),
           canMuteAll: ControlsOptionsUtil.hasHints({
             requiredHints: [DISPLAY_HINTS.MUTE_ALL],
             displayHints: this.userDisplayHints,

package/src/meeting/util.ts

@@ -583,6 +583,8 @@ const MeetingUtil = {
     displayHints.includes(DISPLAY_HINTS.SHARE_WHITEBOARD) &&
     !!policies[SELF_POLICY.SUPPORT_WHITEBOARD],
 
+  canMoveToLobby: (displayHints) => displayHints.includes(DISPLAY_HINTS.MOVE_TO_LOBBY),
+
   /**
    * Adds the current locus sequence information to a request body
    * @param {Object} meeting The meeting object

package/src/members/index.ts

@@ -886,6 +886,31 @@ export default class Members extends StatelessWebexPlugin {
     });
   }
 
+  /**
+   * Moves a meeting member into the lobby.
+   * @param {String} memberId -- The ID of the member to move.
+   * @returns {Promise} -- Resolves with the lobby‐move response.
+   * @public
+   * @memberof Members
+   */
+  public moveToLobby(memberId: string) {
+    if (!this.locusUrl) {
+      return Promise.reject(
+        new ParameterError(
+          'The associated locus url for this meetings members object must be defined.'
+        )
+      );
+    }
+    if (!memberId) {
+      return Promise.reject(
+        new ParameterError('The member id must be defined to move the member to lobby.')
+      );
+    }
+    const body = MembersUtil.getMoveMemberToLobbyRequestBody(memberId);
+
+    return this.membersRequest.moveToLobbyMember({locusUrl: this.locusUrl, memberId}, body);
+  }
+
   /**
    * Raise or lower the hand of a member in a meeting
    * @param {String} memberId

package/src/members/request.ts

@@ -129,6 +129,32 @@ export default class MembersRequest extends StatelessWebexPlugin {
     return this.locusDeltaRequest(requestParams);
   }
 
+  /**
+   * Sends a request to move a meeting member into the lobby.
+   * *
+   * @param {Object} options - Request options.
+   * @param {string} options.locusUrl - The locus URL for the meeting.
+   * @param {string} options.memberId - The ID of the member to move.
+   * @param {Object} body - The request payload.
+   * @param {Object} body.moveToLobby - Container for move‐to‐lobby data.
+   * @param {string[]} body.moveToLobby.participantIds - Array of participant IDs to move.
+   * @returns {Promise} - Resolves with the locus‐delta response.
+   */
+  moveToLobbyMember(
+    options: {locusUrl: string; memberId: string},
+    body: {moveToLobby: {participantIds: string[]}}
+  ) {
+    if (!options || !options.locusUrl || !options.memberId) {
+      throw new ParameterError(
+        'memberId must be defined, and the associated locus url for this meeting object must be defined.'
+      );
+    }
+
+    const requestParams = MembersUtil.getMoveMemberToLobbyRequestParams(options, body);
+
+    return this.locusDeltaRequest(requestParams);
+  }
+
   /**
    * Sends a request to raise or lower a member's hand
    * @param {Object} options

package/src/members/util.ts

@@ -203,6 +203,22 @@ const MembersUtil = {
     };
   },
 
+  getMoveMemberToLobbyRequestBody: (memberId: string) => ({
+    moveToLobby: {
+      participantIds: [memberId],
+    },
+  }),
+
+  getMoveMemberToLobbyRequestParams: (options: {memberId: string; locusUrl: string}, body) => {
+    const uri = `${options.locusUrl}/${PARTICIPANT}/${options.memberId}/${CONTROLS}`;
+
+    return {
+      method: HTTP_VERBS.PATCH,
+      uri,
+      body,
+    };
+  },
+
   /**
    * @param {ServerRoleShape} role
    * @returns {ServerRoleShape} the role shape to be added to the body

package/test/unit/spec/meeting/in-meeting-actions.ts

@@ -99,6 +99,7 @@ describe('plugin-meetings', () => {
         canDisableAnnotation: null,
         canEnableRemoteDesktopControl: null,
         canDisableRemoteDesktopControl: null,
+        canMoveToLobby: null,
 
         ...expected,
       };
@@ -204,6 +205,7 @@ describe('plugin-meetings', () => {
       'canDisableAnnotation',
       'canEnableRemoteDesktopControl',
       'canDisableRemoteDesktopControl',
+      'canMoveToLobby',
     ].forEach((key) => {
       it(`get and set for ${key} work as expected`, () => {
         const inMeetingActions = new InMeetingActions();

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

@@ -10866,6 +10866,7 @@ describe('plugin-meetings', () => {
         let canUserRenameSelfAndObservedSpy;
         let canUserRenameOthersSpy;
         let canShareWhiteBoardSpy;
+        let canMoveToLobbySpy;
         // Due to import tree issues, hasHints must be stubed within the scope of the `it`.
 
         beforeEach(() => {
@@ -10896,6 +10897,7 @@ describe('plugin-meetings', () => {
           );
           canUserRenameOthersSpy = sinon.spy(MeetingUtil, 'canUserRenameOthers');
           canShareWhiteBoardSpy = sinon.spy(MeetingUtil, 'canShareWhiteBoard');
+          canMoveToLobbySpy = sinon.spy(MeetingUtil, 'canMoveToLobby');
         });
 
         afterEach(() => {
@@ -11437,6 +11439,7 @@ describe('plugin-meetings', () => {
           assert.calledWith(requiresPostMeetingDataConsentPromptSpy, userDisplayHints);
           assert.calledWith(canUserRenameOthersSpy, userDisplayHints);
           assert.calledWith(canShareWhiteBoardSpy, userDisplayHints, selfUserPolicies);
+          assert.calledWith(canMoveToLobbySpy, userDisplayHints);
 
           assert.calledWith(ControlsOptionsUtil.hasHints, {
             requiredHints: [DISPLAY_HINTS.MUTE_ALL],

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

@@ -789,10 +789,14 @@ describe('plugin-meetings', () => {
           }),
           false
         );
-        assert.deepEqual(
-          MeetingUtil.canShareWhiteBoard(['SHARE_WHITEBOARD'], undefined),
-          false
-        );
+        assert.deepEqual(MeetingUtil.canShareWhiteBoard(['SHARE_WHITEBOARD'], undefined), false);
+      });
+    });
+
+    describe('canMoveToLobby', () => {
+      it('works as expected', () => {
+        assert.deepEqual(MeetingUtil.canMoveToLobby(['MOVE_TO_LOBBY']), true);
+        assert.deepEqual(MeetingUtil.canMoveToLobby([]), false);
       });
     });
 

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

@@ -120,9 +120,9 @@ describe('plugin-meetings', () => {
       meeting = {
         request: sinon.mock().returns(Promise.resolve()),
         locusInfo: {
-          sequence: {}
-        }
-      }
+          sequence: {},
+        },
+      };
 
       createMembers = (options) => new Members({locusUrl: options.url, meeting}, {parent: webex});
     });
@@ -349,7 +349,7 @@ describe('plugin-meetings', () => {
         {type: 'COHOST', hasRole: true},
       ];
 
-      const resolvedValue = "it worked";
+      const resolvedValue = 'it worked';
 
       const genericMessage = 'Generic error from the API';
 
@@ -364,9 +364,13 @@ describe('plugin-meetings', () => {
         };
 
         if (errorCode) {
-          spies.assignRolesMember = sandbox.stub(members.membersRequest, 'assignRolesMember').rejects({body: {errorCode}, message: genericMessage});
+          spies.assignRolesMember = sandbox
+            .stub(members.membersRequest, 'assignRolesMember')
+            .rejects({body: {errorCode}, message: genericMessage});
         } else {
-          spies.assignRolesMember = sandbox.stub(members.membersRequest, 'assignRolesMember').resolves(resolvedValue);
+          spies.assignRolesMember = sandbox
+            .stub(members.membersRequest, 'assignRolesMember')
+            .resolves(resolvedValue);
         }
 
         return {members, spies};
@@ -378,7 +382,15 @@ describe('plugin-meetings', () => {
         assert.notCalled(spies.assignRolesMember);
       };
 
-      const checkError = async (error, expectedMemberId, expectedRoles, expectedLocusUrl, resultPromise, expectedMessage, spies) => {
+      const checkError = async (
+        error,
+        expectedMemberId,
+        expectedRoles,
+        expectedLocusUrl,
+        resultPromise,
+        expectedMessage,
+        spies
+      ) => {
         await assert.isRejected(resultPromise, error, expectedMessage);
         assert.calledOnceWithExactly(
           spies.generateRoleAssignmentMemberOptions,
@@ -423,7 +435,7 @@ describe('plugin-meetings', () => {
         await checkInvalid(
           resultPromise,
           'The member id must be defined to assign the roles to a member.',
-          spies,
+          spies
         );
       });
 
@@ -435,7 +447,7 @@ describe('plugin-meetings', () => {
         await checkInvalid(
           resultPromise,
           'The associated locus url for this meetings members object must be defined.',
-          spies,
+          spies
         );
       });
 
@@ -452,7 +464,7 @@ describe('plugin-meetings', () => {
           url1,
           resultPromise,
           'Non converged meetings, PSTN or SIP users in converged meetings are not supported currently.',
-          spies,
+          spies
         );
       });
 
@@ -469,7 +481,7 @@ describe('plugin-meetings', () => {
           url1,
           resultPromise,
           'Reclaim Host Role Not Allowed For Other Participants. Participants cannot claim host role in PMR meeting, space instant meeting or escalated instant meeting. However, the original host still can reclaim host role when it manually makes another participant to be the host.',
-          spies,
+          spies
         );
       });
 
@@ -486,7 +498,7 @@ describe('plugin-meetings', () => {
           url1,
           resultPromise,
           'Host Key Not Specified Or Matched. The original host can reclaim the host role without entering the host key. However, any other person who claims the host role must enter the host key to get it.',
-          spies,
+          spies
         );
       });
 
@@ -503,7 +515,7 @@ describe('plugin-meetings', () => {
           url1,
           resultPromise,
           'Participant Having Host Role Already. Participant who sends request to reclaim host role has already a host role.',
-          spies,
+          spies
         );
       });
 
@@ -520,7 +532,7 @@ describe('plugin-meetings', () => {
           url1,
           resultPromise,
           genericMessage,
-          spies,
+          spies
         );
       });
 
@@ -530,13 +542,7 @@ describe('plugin-meetings', () => {
 
         const resultPromise = members.assignRoles(memberId, fakeRoles);
 
-        await checkValid(
-          resultPromise,
-          spies,
-          memberId,
-          fakeRoles,
-          url1,
-        );
+        await checkValid(resultPromise, spies, memberId, fakeRoles, url1);
       });
     });
 
@@ -661,19 +667,19 @@ describe('plugin-meetings', () => {
         spies,
         expectedRequestingMemberId,
         expectedLocusUrl,
-        expectedRoles,
+        expectedRoles
       ) => {
         await assert.isFulfilled(resultPromise);
         assert.calledOnceWithExactly(
           spies.generateLowerAllHandsMemberOptions,
           expectedRequestingMemberId,
           expectedLocusUrl,
-          expectedRoles,
+          expectedRoles
         );
         assert.calledOnceWithExactly(spies.lowerAllHandsMember, {
           requestingParticipantId: expectedRequestingMemberId,
           locusUrl: expectedLocusUrl,
-          ...(expectedRoles !== undefined && { roles: expectedRoles })
+          ...(expectedRoles !== undefined && {roles: expectedRoles}),
         });
         assert.strictEqual(resultPromise, spies.lowerAllHandsMember.getCall(0).returnValue);
       };
@@ -714,7 +720,7 @@ describe('plugin-meetings', () => {
       it('should make the correct request when called with valid requestingMemberId and roles', async () => {
         const requestingMemberId = 'test-member-id';
         const roles = ['panelist', 'attendee'];
-        const { members, spies } = setup('test-locus-url');
+        const {members, spies} = setup('test-locus-url');
 
         const resultPromise = members.lowerAllHands(requestingMemberId, roles);
 
@@ -724,7 +730,7 @@ describe('plugin-meetings', () => {
       it('should handle an empty roles array correctly', async () => {
         const requestingMemberId = 'test-member-id';
         const roles = [];
-        const { members, spies } = setup('test-locus-url');
+        const {members, spies} = setup('test-locus-url');
 
         const resultPromise = members.lowerAllHands(requestingMemberId, roles);
 
@@ -977,5 +983,76 @@ describe('plugin-meetings', () => {
         );
       });
     });
+
+    describe('#moveToLobby', () => {
+      const setup = (locusUrl) => {
+        const members = createMembers({url: locusUrl});
+
+        const spies = {
+          getMoveMemberToLobbyRequestBody: sandbox.spy(
+            MembersUtil,
+            'getMoveMemberToLobbyRequestBody'
+          ),
+          moveToLobbyMember: sandbox.spy(members.membersRequest, 'moveToLobbyMember'),
+        };
+
+        return {members, spies};
+      };
+
+      const checkInvalid = async (resultPromise, expectedMessage, spies) => {
+        await assert.isRejected(resultPromise, ParameterError, expectedMessage);
+        assert.notCalled(spies.getMoveMemberToLobbyRequestBody);
+        assert.notCalled(spies.moveToLobbyMember);
+      };
+
+      const checkValid = async (resultPromise, spies, expectedMemberId, expectedLocusUrl) => {
+        await assert.isFulfilled(resultPromise);
+        assert.calledOnceWithExactly(spies.getMoveMemberToLobbyRequestBody, expectedMemberId);
+        assert.calledOnceWithExactly(
+          spies.moveToLobbyMember,
+          {
+            locusUrl: expectedLocusUrl,
+            memberId: expectedMemberId,
+          },
+          {
+            moveToLobby: {participantIds: [expectedMemberId]},
+          }
+        );
+        assert.strictEqual(resultPromise, spies.moveToLobbyMember.getCall(0).returnValue);
+      };
+
+      it('should not make a request if there is no member id', async () => {
+        const {members, spies} = setup(url1);
+
+        const resultPromise = members.moveToLobby();
+
+        await checkInvalid(
+          resultPromise,
+          'The member id must be defined to move the member to lobby.',
+          spies
+        );
+      });
+
+      it('should not make a request if there is no locus url', async () => {
+        const {members, spies} = setup();
+
+        const resultPromise = members.moveToLobby(uuid.v4());
+
+        await checkInvalid(
+          resultPromise,
+          'The associated locus url for this meetings members object must be defined.',
+          spies
+        );
+      });
+
+      it('should make the correct request when called with valid memberId and locusUrl', async () => {
+        const memberId = uuid.v4();
+        const {members, spies} = setup(url1);
+
+        const resultPromise = members.moveToLobby(memberId);
+
+        await checkValid(resultPromise, spies, memberId, url1);
+      });
+    });
   });
 });

package/test/unit/spec/members/request.js

@@ -9,7 +9,7 @@ import Meetings from '@webex/plugin-meetings';
 import MembersRequest from '@webex/plugin-meetings/src/members/request';
 import membersUtil from '@webex/plugin-meetings/src/members/util';
 import ParameterError from '@webex/plugin-meetings/src/common/errors/parameter';
-import { merge } from 'lodash';
+import {merge} from 'lodash';
 
 const {assert} = chai;
 
@@ -65,10 +65,7 @@ describe('plugin-meetings', () => {
 
   const checkRequest = (expectedParams) => {
     assert.calledOnceWithExactly(locusDeltaRequestSpy, expectedParams);
-    assert.calledOnceWithExactly(
-      membersRequest.request,
-      merge(expectedParams, {body: {sequence}})
-    );
+    assert.calledOnceWithExactly(membersRequest.request, merge(expectedParams, {body: {sequence}}));
   };
 
   describe('members request library', () => {
@@ -98,8 +95,8 @@ describe('plugin-meetings', () => {
             },
             device: {
               url,
-            }
-          }
+            },
+          },
         });
       });
     });
@@ -120,9 +117,9 @@ describe('plugin-meetings', () => {
           uri: url1,
           body: {
             alertIfActive: undefined,
-            invitees: [{address: '+18578675309'}]
-          }
-        })
+            invitees: [{address: '+18578675309'}],
+          },
+        });
       });
     });
 
@@ -133,16 +130,16 @@ describe('plugin-meetings', () => {
           memberIds: ['1', '2'],
         };
 
-        await membersRequest.admitMember(options)
+        await membersRequest.admitMember(options);
 
         checkRequest({
           method: 'PUT',
           uri: 'https://example.com/12345/controls',
           body: {
             admit: {
-              participantIds: options.memberIds
-            }
-          }
+              participantIds: options.memberIds,
+            },
+          },
         });
       });
     });
@@ -160,7 +157,7 @@ describe('plugin-meetings', () => {
           method: 'PUT',
           uri: 'https://example.com/12345/participant/member1/leave',
           body: {
-            reason: undefined
+            reason: undefined,
           },
         });
       });
@@ -247,9 +244,9 @@ describe('plugin-meetings', () => {
           uri: `${locusUrl}/participant/${memberId}/controls`,
           body: {
             role: {
-              roles
-            }
-          }
+              roles,
+            },
+          },
         });
       });
     });
@@ -272,9 +269,9 @@ describe('plugin-meetings', () => {
           uri: `${locusUrl}/participant/${memberId}/controls`,
           body: {
             hand: {
-              raised: true
-            }
-          }
+              raised: true,
+            },
+          },
         });
       });
     });
@@ -406,7 +403,33 @@ describe('plugin-meetings', () => {
           body: {
             aliasValue,
             requestingParticipantId,
-          }
+          },
+        });
+      });
+    });
+
+    describe('#moveToLobby', () => {
+      it('sends a moveToLobbyMember PATCH to the locus endpoint', async () => {
+        const locusUrl = url1;
+        const memberId = 'test1';
+        const options = {
+          locusUrl: locusUrl,
+          memberId,
+        };
+        const body = {
+          moveToLobby: {participantIds: [memberId]},
+        };
+
+        const getRequestParamsSpy = sandbox.spy(membersUtil, 'getMoveMemberToLobbyRequestParams');
+
+        await membersRequest.moveToLobbyMember(options, body);
+
+        assert.calledOnceWithExactly(getRequestParamsSpy, options, body);
+
+        checkRequest({
+          method: 'PATCH',
+          uri: `${locusUrl}/participant/${memberId}/controls`,
+          body: {moveToLobby: {participantIds: [memberId]}},
         });
       });
     });