@webex/plugin-meetings 3.0.0-beta.116 → 3.0.0-beta.117

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

@@ -1,2 +1,210 @@
-declare const MembersUtil: any;
+import { RoleAssignmentOptions, RoleAssignmentRequest, ServerRoleShape } from './types';
+declare const MembersUtil: {
+    /**
+     * @param {Object} invitee with emailAddress, email or phoneNumber
+     * @param {String} locusUrl
+     * @param {Boolean} alertIfActive
+     * @returns {Object} the format object
+     */
+    generateAddMemberOptions: (invitee: object, locusUrl: string, alertIfActive: boolean) => {
+        invitee: object;
+        locusUrl: string;
+        alertIfActive: boolean;
+    };
+    /**
+     * @param {Array} memberIds
+     * @param {String} locusUrl
+     * @returns {Object} the format object
+     */
+    generateAdmitMemberOptions: (memberIds: Array<any>, locusUrl: string) => {
+        locusUrl: string;
+        memberIds: any[];
+    };
+    /**
+     * @param {Object} options with {invitee: {emailAddress, email, phoneNumber}, alertIfActive}
+     * @returns {Object} with {invitees: [{address}], alertIfActive}
+     */
+    getAddMemberBody: (options: any) => {
+        invitees: {
+            address: any;
+        }[];
+        alertIfActive: any;
+    };
+    /**
+     * @param {Object} options with {memberIds, authorizingLocusUrl}
+     * @returns {Object} admit with {memberIds}
+     */
+    getAdmitMemberRequestBody: (options: any) => any;
+    /**
+     * @param {Object} format with {memberIds, locusUrl, sessionLocusUrls}
+     * @returns {Object} the request parameters (method, uri, body) needed to make a admitMember request
+     * if a host/cohost is in a breakout session, the locus url should be the main session locus url
+     */
+    getAdmitMemberRequestParams: (format: any) => {
+        method: string;
+        uri: string;
+        body: any;
+    };
+    /**
+     * @param {Object} format with {invitee {emailAddress, email, phoneNumber}, locusUrl, alertIfActive}
+     * @returns {Object} the request parameters (method, uri, body) needed to make a addMember request
+     */
+    getAddMemberRequestParams: (format: any) => {
+        method: string;
+        uri: any;
+        body: {
+            invitees: {
+                address: any;
+            }[];
+            alertIfActive: any;
+        };
+    };
+    isInvalidInvitee: (invitee: any) => boolean;
+    getRemoveMemberRequestParams: (options: any) => {
+        method: string;
+        uri: string;
+        body: {
+            reason: any;
+        };
+    };
+    generateTransferHostMemberOptions: (transfer: any, moderator: any, locusUrl: any) => {
+        moderator: any;
+        locusUrl: any;
+        memberId: any;
+    };
+    generateRemoveMemberOptions: (removal: any, locusUrl: any) => {
+        reason: string;
+        memberId: any;
+        locusUrl: any;
+    };
+    generateMuteMemberOptions: (memberId: any, status: any, locusUrl: any, isAudio: any) => {
+        memberId: any;
+        muted: any;
+        locusUrl: any;
+        isAudio: any;
+    };
+    generateRaiseHandMemberOptions: (memberId: any, status: any, locusUrl: any) => {
+        memberId: any;
+        raised: any;
+        locusUrl: any;
+    };
+    /**
+     * @param {String} memberId
+     * @param {[ServerRoleShape]} roles
+     * @param {String} locusUrl
+     * @returns {RoleAssignmentOptions}
+     */
+    generateRoleAssignmentMemberOptions: (memberId: string, roles: Array<ServerRoleShape>, locusUrl: string) => RoleAssignmentOptions;
+    generateLowerAllHandsMemberOptions: (requestingParticipantId: any, locusUrl: any) => {
+        requestingParticipantId: any;
+        locusUrl: any;
+    };
+    /**
+     * @param {String} memberId id of the participant who is receiving request
+     * @param {String} requestingParticipantId id of the participant who is sending request (optional)
+     * @param {String} alias alias name
+     * @param {String} locusUrl url
+     * @returns {Object} consists of {memberID: string, requestingParticipantId: string, alias: string, locusUrl: string}
+     */
+    generateEditDisplayNameMemberOptions: (memberId: any, requestingParticipantId: any, alias: any, locusUrl: any) => {
+        memberId: any;
+        requestingParticipantId: any;
+        alias: any;
+        locusUrl: any;
+    };
+    getMuteMemberRequestParams: (options: any) => {
+        method: string;
+        uri: string;
+        body: {
+            [x: string]: {
+                muted: any;
+            };
+        };
+    };
+    /**
+     * @param {RoleAssignmentOptions} options
+     * @returns {RoleAssignmentRequest} the request parameters (method, uri, body) needed to make a addMember request
+     */
+    getRoleAssignmentMemberRequestParams: (options: RoleAssignmentOptions) => RoleAssignmentRequest;
+    getRaiseHandMemberRequestParams: (options: any) => {
+        method: string;
+        uri: string;
+        body: {
+            hand: {
+                raised: any;
+            };
+        };
+    };
+    getLowerAllHandsMemberRequestParams: (options: any) => {
+        method: string;
+        uri: string;
+        body: {
+            hand: {
+                raised: boolean;
+            };
+            requestingParticipantId: any;
+        };
+    };
+    /**
+     * @param {Object} options with format of {locusUrl: string, requestingParticipantId: string}
+     * @returns {Object} request parameters (method, uri, body) needed to make a editDisplayName request
+     */
+    editDisplayNameMemberRequestParams: (options: any) => {
+        method: string;
+        uri: string;
+        body: {
+            aliasValue: any;
+            requestingParticipantId: any;
+        };
+    };
+    getTransferHostToMemberRequestParams: (options: any) => {
+        method: string;
+        uri: string;
+        body: {
+            role: {
+                moderator: any;
+            };
+        };
+    };
+    genderateSendDTMFOptions: (url: any, tones: any, memberId: any, locusUrl: any) => {
+        url: any;
+        tones: any;
+        memberId: any;
+        locusUrl: any;
+    };
+    generateSendDTMFRequestParams: ({ url, tones, memberId, locusUrl }: {
+        url: any;
+        tones: any;
+        memberId: any;
+        locusUrl: any;
+    }) => {
+        method: string;
+        uri: string;
+        body: {
+            device: {
+                url: any;
+            };
+            memberId: any;
+            dtmf: {
+                correlationId: any;
+                tones: any;
+                direction: string;
+            };
+        };
+    };
+    cancelPhoneInviteOptions: (invitee: any, locusUrl: any) => {
+        invitee: any;
+        locusUrl: any;
+    };
+    generateCancelInviteRequestParams: (options: any) => {
+        method: string;
+        uri: any;
+        body: {
+            actionType: string;
+            invitees: {
+                address: any;
+            }[];
+        };
+    };
+};
 export default MembersUtil;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webex/plugin-meetings",
-  "version": "3.0.0-beta.116",
+  "version": "3.0.0-beta.117",
   "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.116",
-    "@webex/test-helper-chai": "3.0.0-beta.116",
-    "@webex/test-helper-mocha": "3.0.0-beta.116",
-    "@webex/test-helper-mock-webex": "3.0.0-beta.116",
-    "@webex/test-helper-retry": "3.0.0-beta.116",
-    "@webex/test-helper-test-users": "3.0.0-beta.116",
+    "@webex/plugin-meetings": "3.0.0-beta.117",
+    "@webex/test-helper-chai": "3.0.0-beta.117",
+    "@webex/test-helper-mocha": "3.0.0-beta.117",
+    "@webex/test-helper-mock-webex": "3.0.0-beta.117",
+    "@webex/test-helper-retry": "3.0.0-beta.117",
+    "@webex/test-helper-test-users": "3.0.0-beta.117",
     "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.116",
+    "@webex/common": "3.0.0-beta.117",
     "@webex/internal-media-core": "1.38.0",
-    "@webex/internal-plugin-conversation": "3.0.0-beta.116",
-    "@webex/internal-plugin-device": "3.0.0-beta.116",
-    "@webex/internal-plugin-llm": "3.0.0-beta.116",
-    "@webex/internal-plugin-mercury": "3.0.0-beta.116",
-    "@webex/internal-plugin-metrics": "3.0.0-beta.116",
-    "@webex/internal-plugin-support": "3.0.0-beta.116",
-    "@webex/internal-plugin-user": "3.0.0-beta.116",
-    "@webex/media-helpers": "3.0.0-beta.116",
-    "@webex/plugin-people": "3.0.0-beta.116",
-    "@webex/plugin-rooms": "3.0.0-beta.116",
-    "@webex/webex-core": "3.0.0-beta.116",
+    "@webex/internal-plugin-conversation": "3.0.0-beta.117",
+    "@webex/internal-plugin-device": "3.0.0-beta.117",
+    "@webex/internal-plugin-llm": "3.0.0-beta.117",
+    "@webex/internal-plugin-mercury": "3.0.0-beta.117",
+    "@webex/internal-plugin-metrics": "3.0.0-beta.117",
+    "@webex/internal-plugin-support": "3.0.0-beta.117",
+    "@webex/internal-plugin-user": "3.0.0-beta.117",
+    "@webex/media-helpers": "3.0.0-beta.117",
+    "@webex/plugin-people": "3.0.0-beta.117",
+    "@webex/plugin-rooms": "3.0.0-beta.117",
+    "@webex/webex-core": "3.0.0-beta.117",
     "ampersand-collection": "^2.0.2",
     "bowser": "^2.11.0",
     "btoa": "^1.2.1",

package/src/breakouts/breakout.ts

@@ -47,8 +47,11 @@ const Breakout = WebexPlugin.extend({
     },
   },
 
+  /**
+   * initializer for the Breakout class
+   * @returns {void}
+   */
   initialize() {
-    this.members = new Members({}, {parent: this.webex});
     // @ts-ignore
     this.breakoutRequest = new BreakoutRequest({webex: this.webex});
   },
@@ -113,15 +116,34 @@ const Breakout = WebexPlugin.extend({
   },
 
   /**
-   * Parses the participants from the locus object
-   * @param locus Locus object
+   * inits the members object
    * @returns {void}
    */
+  initMembers() {
+    const {meetingId} = this.collection.parent;
+    const meeting = this.webex.meetings.getMeetingByType(_ID_, meetingId);
+    this.members = new Members(
+      {
+        meeting,
+      },
+      {parent: this.webex}
+    );
+  },
 
+  /**
+   * Parses the participants from the locus object
+   * @param {Object} locus Locus object
+   * @returns {void}
+   */
   parseRoster(locus) {
+    if (!this.members) {
+      this.initMembers();
+    }
+
     this.members.locusParticipantsUpdate(locus);
   },
-  /*
+
+  /**
    * Broadcast message to this breakout session's participants
    * @param {String} message
    * @param {Object} options

package/src/breakouts/index.ts

@@ -456,6 +456,17 @@ const Breakouts = WebexPlugin.extend({
     });
   },
 
+  /**
+   * set groups to manageGroups prop
+   * @param {Object} breakoutInfo -- breakout groups
+   * @returns {void}
+   */
+  _setManageGroups(breakoutInfo) {
+    if (breakoutInfo?.body?.groups) {
+      this.set('manageGroups', breakoutInfo.body.groups);
+    }
+  },
+
   /**
    * Create new breakout sessions
    * @param {object} params -- breakout session group
@@ -468,7 +479,7 @@ const Breakouts = WebexPlugin.extend({
       ...{groups: [payload]},
     };
     // @ts-ignore
-    const breakInfo = await this.webex
+    const breakoutInfo = await this.webex
       .request({
         method: HTTP_VERBS.PUT,
         uri: this.url,
@@ -478,14 +489,12 @@ const Breakouts = WebexPlugin.extend({
         return Promise.reject(boServiceErrorHandler(error, 'Breakouts#create'));
       });
 
-    if (breakInfo.body?.groups) {
-      this.set('manageGroups', breakInfo.body.groups);
-    }
+    this._setManageGroups(breakoutInfo);
 
     // clear edit lock info after save breakout session info
     this._clearEditLockInfo();
 
-    return Promise.resolve(breakInfo);
+    return breakoutInfo;
   },
 
   /**
@@ -498,7 +507,7 @@ const Breakouts = WebexPlugin.extend({
       ...{groups: [{action: BREAKOUTS.ACTION.DELETE}]},
     };
     // @ts-ignore
-    const breakInfo = await this.webex
+    const breakoutInfo = await this.webex
       .request({
         method: HTTP_VERBS.PUT,
         uri: this.url,
@@ -508,12 +517,10 @@ const Breakouts = WebexPlugin.extend({
         return Promise.reject(boServiceErrorHandler(error, 'Breakouts#clearSessions'));
       });
 
-    if (breakInfo.body?.groups) {
-      this.set('manageGroups', breakInfo.body.groups);
-    }
+    this._setManageGroups(breakoutInfo);
     this.shouldFetchPreassignments = false;
 
-    return Promise.resolve(breakInfo);
+    return breakoutInfo;
   },
 
   /**
@@ -521,7 +528,7 @@ const Breakouts = WebexPlugin.extend({
    * @param {object} params
    * @returns {Promise}
    */
-  start(params = {}) {
+  async start(params = {}) {
     const action = BREAKOUTS.ACTION.START;
     const payload = {
       id: this.breakoutGroupId,
@@ -539,13 +546,17 @@ const Breakouts = WebexPlugin.extend({
       ...{groups: [payload]},
     };
 
-    return this.request({
+    const breakoutInfo = await this.request({
       method: HTTP_VERBS.PUT,
       uri: this.url,
       body,
     }).catch((error) => {
       return Promise.reject(boServiceErrorHandler(error, 'Breakouts#start'));
     });
+
+    this._setManageGroups(breakoutInfo);
+
+    return breakoutInfo;
   },
 
   /**
@@ -553,7 +564,7 @@ const Breakouts = WebexPlugin.extend({
    * @param {object} params
    * @returns {Promise}
    */
-  end(params = {}) {
+  async end(params = {}) {
     const {delayCloseTime, breakoutGroupId: id} = this;
     const action = BREAKOUTS.ACTION.CLOSE;
     const payload = {
@@ -570,13 +581,17 @@ const Breakouts = WebexPlugin.extend({
       ...{groups: [payload]},
     };
 
-    return this.request({
+    const breakoutInfo = await this.request({
       method: HTTP_VERBS.PUT,
       uri: this.url,
       body,
     }).catch((error) => {
       return Promise.reject(boServiceErrorHandler(error, 'Breakouts#end'));
     });
+
+    this._setManageGroups(breakoutInfo);
+
+    return breakoutInfo;
   },
 
   /**
@@ -611,6 +626,8 @@ const Breakouts = WebexPlugin.extend({
       this._clearEditLockInfo();
     }
 
+    this._setManageGroups(breakoutInfo);
+
     return breakoutInfo;
   },
 
@@ -625,9 +642,7 @@ const Breakouts = WebexPlugin.extend({
       uri: this.url + (editlock ? `?editlock=${editlock}` : ''),
     });
 
-    if (breakout.body?.groups) {
-      this.set('manageGroups', breakout.body.groups);
-    }
+    this._setManageGroups(breakout);
     if (editlock && breakout.body?.editlock?.token) {
       this.set('editLock', breakout.body.editlock);
       this.keepEditLockAlive();

package/src/meeting/index.ts

@@ -748,6 +748,7 @@ export default class Meeting extends StatelessWebexPlugin {
         locusUrl: attrs.locus && attrs.locus.url,
         receiveSlotManager: this.receiveSlotManager,
         mediaRequestManagers: this.mediaRequestManagers,
+        meeting: this,
       },
       // @ts-ignore - Fix type
       {parent: this.webex}
@@ -890,7 +891,12 @@ export default class Meeting extends StatelessWebexPlugin {
      * @private
      * @memberof Meeting
      */
-    this.meetingRequest = new MeetingRequest({}, options);
+    this.meetingRequest = new MeetingRequest(
+      {
+        meeting: this,
+      },
+      options
+    );
     /**
      * @instance
      * @type {Array}
@@ -3240,35 +3246,6 @@ export default class Meeting extends StatelessWebexPlugin {
     }
   }
 
-  /**
-   * Sets the first locus info on the class instance
-   * @param {Object} locus
-   * @param {String} locus.url
-   * @param {Array} locus.participants
-   * @param {Object} locus.self
-   * @returns {undefined}
-   * @private
-   * @memberof Meeting
-   */
-  private parseLocus(locus: {url: string; participants: Array<any>; self: object}) {
-    if (locus) {
-      this.locusUrl = locus.url;
-      // TODO: move this to parse participants module
-      this.setLocus(locus);
-
-      // check if we can extract this info from partner
-      // Parsing of locus object must be finished at this state
-      if (locus.participants && locus.self) {
-        this.partner = MeetingUtil.getLocusPartner(locus.participants, locus.self);
-      }
-
-      // For webex meeting the sipUrl gets updated in info parser
-      if (!this.sipUri && this.partner && this.type === _CALL_) {
-        this.setSipUri(this.partner.person.sipUrl || this.partner.person.id);
-      }
-    }
-  }
-
   /**
    * Sets the sip uri on the class instance
    * uses meeting info as precedence
@@ -3295,7 +3272,7 @@ export default class Meeting extends StatelessWebexPlugin {
    * @private
    * @memberof Meeting
    */
-  private setLocus(
+  setLocus(
     locus:
       | {
           mediaConnections: Array<any>;
@@ -4665,9 +4642,6 @@ export default class Meeting extends StatelessWebexPlugin {
           locusUrl,
           clientUrl: this.deviceUrl,
         })
-        .then((res) => {
-          this.locusInfo.onFullLocus(res.body.locus);
-        })
         .catch((error) => {
           Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.ADD_DIAL_IN_FAILURE, {
             correlation_id: this.correlationId,
@@ -4707,9 +4681,6 @@ export default class Meeting extends StatelessWebexPlugin {
           locusUrl,
           clientUrl: this.deviceUrl,
         })
-        .then((res) => {
-          this.locusInfo.onFullLocus(res.body.locus);
-        })
         .catch((error) => {
           Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.ADD_DIAL_OUT_FAILURE, {
             correlation_id: this.correlationId,
@@ -6843,11 +6814,6 @@ export default class Meeting extends StatelessWebexPlugin {
         main: layoutInfo.main,
         content: layoutInfo.content,
       })
-      .then((response) => {
-        if (response && response.body && response.body.locus) {
-          this.locusInfo.onFullLocus(response.body.locus);
-        }
-      })
       .catch((error) => {
         LoggerProxy.logger.error('Meeting:index#changeVideoLayout --> Error ', error);
 

package/src/meeting/locusMediaRequest.ts

@@ -14,6 +14,7 @@ export type RoapRequest = {
   mediaId: string;
   roapMessage: any;
   reachability: any;
+  sequence?: any;
   joinCookie: any; // any, because this is opaque to the client, we pass whatever object we got from one backend component (Orpheus) to the other (Locus)
 };
 
@@ -21,6 +22,7 @@ export type LocalMuteRequest = {
   type: 'LocalMute';
   selfUrl: string;
   mediaId: string;
+  sequence?: any;
   muteOptions: {
     audioMuted?: boolean;
     videoMuted?: boolean;
@@ -220,6 +222,10 @@ export class LocusMediaRequest extends WebexPlugin {
         break;
     }
 
+    if (request.sequence) {
+      body.sequence = request.sequence;
+    }
+
     body.localMedias = [
       {
         localSdp: JSON.stringify(localMedias), // this part must be JSON stringified, Locus requires this

package/src/meeting/muteState.ts

@@ -343,7 +343,7 @@ export class MuteState {
         this.state.server.localMute = this.type === AUDIO ? audioMuted : videoMuted;
 
         if (locus) {
-          meeting.locusInfo.onFullLocus(locus);
+          meeting.locusInfo.onDeltaLocus(locus);
         }
 
         return locus;