@webex/plugin-meetings 3.8.1-next.32 → 3.8.1-next.33

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

@@ -4,6 +4,7 @@ import MembersCollection from './collection';
 import { ReceiveSlotManager } from '../multistream/receiveSlotManager';
 import { MediaRequestManager } from '../multistream/mediaRequestManager';
 import { ServerRoleShape } from './types';
+import { Invitee } from '../meeting/type';
 /**
  * @class Members
  */
@@ -212,31 +213,28 @@ export default class Members extends StatelessWebexPlugin {
     private update;
     /**
      * Adds a guest Member to the associated meeting
-     * @param {String} invitee
+     * @param {Invitee} invitee
      * @param {Boolean} [alertIfActive]
      * @returns {Promise}
      * @memberof Members
      */
-    addMember(invitee: any, alertIfActive?: boolean): any;
+    addMember(invitee: Invitee, alertIfActive?: boolean): any;
     /**
      * Cancels an outgoing PSTN call to the associated meeting
-     * @param {String} invitee
+     * @param {Invitee} invitee
      * @returns {Promise}
      * @memberof Members
      */
-    cancelPhoneInvite(invitee: any): any;
+    cancelPhoneInvite(invitee: Invitee): any;
     /**
      * Cancels an SIP/phone call to the associated meeting
-     * @param {Object} invitee
+     * @param {Invitee} invitee
      * @param {String} invitee.memberId - The memberId of the invitee
      * @param {Boolean} [invitee.isInternalNumber] - When cancel phone invitation, if the number is internal
      * @returns {Promise}
      * @memberof Members
      */
-    cancelInviteByMemberId(invitee: {
-        memberId: string;
-        isInternalNumber?: boolean;
-    }): any;
+    cancelInviteByMemberId(invitee: Invitee): any;
     /**
      * Admits waiting members (invited guests to meeting)
      * @param {Array} memberIds

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

@@ -1,4 +1,5 @@
 import { RoleAssignmentOptions, RoleAssignmentRequest, ServerRoleShape } from './types';
+import { Invitee } from '../meeting/type';
 declare const MembersUtil: {
     /**
      * @param {Object} invitee with emailAddress, email or phoneNumber
@@ -63,7 +64,7 @@ declare const MembersUtil: {
             alertIfActive: any;
         };
     };
-    isInvalidInvitee: (invitee: any) => boolean;
+    isInvalidInvitee: (invitee: Invitee) => boolean;
     getRemoveMemberRequestParams: (options: any) => {
         method: string;
         uri: string;

package/dist/webinar/index.js

@@ -458,7 +458,7 @@ var Webinar = _webexCore.WebexPlugin.extend({
       }, _callee7);
     }))();
   },
-  version: "3.8.1-next.32"
+  version: "3.8.1-next.33"
 });
 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.1-next.32",
+    "@webex/plugin-meetings": "3.8.1-next.33",
     "@webex/plugin-rooms": "3.8.1-next.7",
     "@webex/test-helper-chai": "3.8.1-next.10",
     "@webex/test-helper-mocha": "3.8.1-next.10",
@@ -71,7 +71,7 @@
     "@webex/internal-plugin-metrics": "3.8.1-next.10",
     "@webex/internal-plugin-support": "3.8.1-next.10",
     "@webex/internal-plugin-user": "3.8.1-next.10",
-    "@webex/internal-plugin-voicea": "3.8.1-next.32",
+    "@webex/internal-plugin-voicea": "3.8.1-next.33",
     "@webex/media-helpers": "3.8.1-next.14",
     "@webex/plugin-people": "3.8.1-next.10",
     "@webex/plugin-rooms": "3.8.1-next.7",
@@ -93,5 +93,5 @@
   "//": [
     "TODO: upgrade jwt-decode when moving to node 18"
   ],
-  "version": "3.8.1-next.32"
+  "version": "3.8.1-next.33"
 }

package/src/meeting/index.ts

@@ -166,6 +166,7 @@ import MultistreamNotSupportedError from '../common/errors/multistream-not-suppo
 import JoinForbiddenError from '../common/errors/join-forbidden-error';
 import {ReachabilityMetrics} from '../reachability/reachability.types';
 import {SetStageOptions, SetStageVideoLayout, UnsetStageVideoLayout} from './request.type';
+import {Invitee} from './type';
 
 // default callback so we don't call an undefined function, but in practice it should never be used
 const DEFAULT_ICE_PHASE_CALLBACK = () => 'JOIN_MEETING_FINAL';
@@ -3839,49 +3840,43 @@ export default class Meeting extends StatelessWebexPlugin {
 
   /**
    * Invite a guest to the call that isn't normally part of this call
-   * @param {Object} invitee
+   * @param {Invitee} invitee
    * @param {String} invitee.emailAddress
    * @param {String} invitee.email
    * @param {String} invitee.phoneNumber
    * @param {Boolean} [alertIfActive]
+   * @param {Boolean} [invitee.skipEmailValidation]
+   * @param {Boolean} [invitee.isInternalNumber]
    * @returns {Promise} see #members.addMember
    * @public
    * @memberof Meeting
    */
-  public invite(
-    invitee: {
-      emailAddress: string;
-      email: string;
-      phoneNumber: string;
-      roles: Array<string>;
-    },
-    alertIfActive = true
-  ) {
+  public invite(invitee: Invitee, alertIfActive = true) {
     return this.members.addMember(invitee, alertIfActive);
   }
 
   /**
    * Cancel an outgoing phone call invitation made during a meeting
-   * @param {Object} invitee
+   * @param {Invitee} invitee
    * @param {String} invitee.phoneNumber
    * @returns {Promise} see #members.cancelPhoneInvite
    * @public
    * @memberof Meeting
    */
-  public cancelPhoneInvite(invitee: {phoneNumber: string}) {
+  public cancelPhoneInvite(invitee: Invitee) {
     return this.members.cancelPhoneInvite(invitee);
   }
 
   /**
    * Cancel an SIP/phone call invitation made during a meeting
-   * @param {Object} invitee
+   * @param {Invitee} invitee
    * @param {String} invitee.memberId
    * @param {Boolean} [invitee.isInternalNumber] - When cancel phone invitation, if the number is internal
    * @returns {Promise} see #members.cancelInviteByMemberId
    * @public
    * @memberof Meeting
    */
-  public cancelInviteByMemberId(invitee: {memberId: string; isInternalNumber?: boolean}) {
+  public cancelInviteByMemberId(invitee: Invitee) {
     return this.members.cancelInviteByMemberId(invitee);
   }
 

package/src/meeting/type.ts

@@ -0,0 +1,9 @@
+export type Invitee = {
+  memberId: string;
+  emailAddress: string;
+  email: string;
+  phoneNumber: string;
+  roles: Array<string>;
+  skipEmailValidation?: boolean;
+  isInternalNumber?: boolean;
+};

package/src/members/index.ts

@@ -30,6 +30,7 @@ import MembersUtil from './util';
 import {ReceiveSlotManager} from '../multistream/receiveSlotManager';
 import {MediaRequestManager} from '../multistream/mediaRequestManager';
 import {ServerRoleShape} from './types';
+import {Invitee} from '../meeting/type';
 
 /**
  * Members Update Event
@@ -800,18 +801,18 @@ export default class Members extends StatelessWebexPlugin {
 
   /**
    * Adds a guest Member to the associated meeting
-   * @param {String} invitee
+   * @param {Invitee} invitee
    * @param {Boolean} [alertIfActive]
    * @returns {Promise}
    * @memberof Members
    */
-  addMember(invitee: any, alertIfActive?: boolean) {
+  addMember(invitee: Invitee, alertIfActive?: boolean) {
     if (!this.locusUrl) {
       return Promise.reject(
         new ParameterError('The associated locus url for this meeting object must be defined.')
       );
     }
-    if (MembersUtil.isInvalidInvitee(invitee)) {
+    if (invitee?.skipEmailValidation !== true && MembersUtil.isInvalidInvitee(invitee)) {
       return Promise.reject(
         new ParameterError(
           'The invitee must be defined with either a valid email, emailAddress or phoneNumber property.'
@@ -825,11 +826,11 @@ export default class Members extends StatelessWebexPlugin {
 
   /**
    * Cancels an outgoing PSTN call to the associated meeting
-   * @param {String} invitee
+   * @param {Invitee} invitee
    * @returns {Promise}
    * @memberof Members
    */
-  cancelPhoneInvite(invitee: any) {
+  cancelPhoneInvite(invitee: Invitee) {
     if (!this.locusUrl) {
       return Promise.reject(
         new ParameterError('The associated locus url for this meeting object must be defined.')
@@ -847,13 +848,13 @@ export default class Members extends StatelessWebexPlugin {
 
   /**
    * Cancels an SIP/phone call to the associated meeting
-   * @param {Object} invitee
+   * @param {Invitee} invitee
    * @param {String} invitee.memberId - The memberId of the invitee
    * @param {Boolean} [invitee.isInternalNumber] - When cancel phone invitation, if the number is internal
    * @returns {Promise}
    * @memberof Members
    */
-  cancelInviteByMemberId(invitee: {memberId: string; isInternalNumber?: boolean}) {
+  cancelInviteByMemberId(invitee: Invitee) {
     if (!this.locusUrl) {
       return Promise.reject(
         new ParameterError('The associated locus url for this meeting object must be defined.')

package/src/members/util.ts

@@ -14,6 +14,7 @@ import {
 } from '../constants';
 
 import {RoleAssignmentOptions, RoleAssignmentRequest, ServerRoleShape} from './types';
+import {Invitee} from '../meeting/type';
 
 const MembersUtil = {
   /**
@@ -105,7 +106,7 @@ const MembersUtil = {
     return requestParams;
   },
 
-  isInvalidInvitee: (invitee) => {
+  isInvalidInvitee: (invitee: Invitee) => {
     if (!(invitee && (invitee.email || invitee.emailAddress || invitee.phoneNumber))) {
       return true;
     }

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

@@ -56,6 +56,7 @@ import * as MeetingRequestImport from '@webex/plugin-meetings/src/meeting/reques
 import LocusInfo from '@webex/plugin-meetings/src/locus-info';
 import MediaProperties from '@webex/plugin-meetings/src/media/properties';
 import MeetingUtil from '@webex/plugin-meetings/src/meeting/util';
+import MembersUtil from '@webex/plugin-meetings/src/members/util';
 import MeetingsUtil from '@webex/plugin-meetings/src/meetings/util';
 import Media from '@webex/plugin-meetings/src/media/index';
 import ReconnectionManager from '@webex/plugin-meetings/src/reconnection-manager';
@@ -610,7 +611,6 @@ describe('plugin-meetings', () => {
           assert.isFalse(meeting.isLocusCall());
         });
       });
-
       describe('#invite', () => {
         it('should have #invite', () => {
           assert.exists(meeting.invite);
@@ -621,8 +621,6 @@ describe('plugin-meetings', () => {
         it('should proxy members #addMember and return a promise', async () => {
           const invite = meeting.invite(uuid1, false);
 
-          assert.exists(invite.then);
-          await invite;
           assert.calledOnce(meeting.members.addMember);
           assert.calledWith(meeting.members.addMember, uuid1, false);
         });

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

@@ -177,6 +177,26 @@ describe('plugin-meetings', () => {
         assert.isFalse(MembersUtil.isInvalidInvitee({email: 'sip:test@cisco.com'}), 'SIP email should be valid');
       });
 
+      it('should skip email validation if skipEmailValidation is true', async () => {
+        sandbox.spy(MembersUtil, 'isInvalidInvitee');
+
+        const members = createMembers({url: true});
+        
+        await members.addMember({email: '8618578675309', skipEmailValidation: true});
+        
+        assert.notCalled(MembersUtil.isInvalidInvitee);
+      });
+
+      it('should not skip email validation if skipEmailValidation is not equal true', async () => {
+        sandbox.spy(MembersUtil, 'isInvalidInvitee');
+
+        const members = createMembers({url: true});
+        
+        await members.addMember({email: '86185786@ds.com'});
+        
+        assert.called(MembersUtil.isInvalidInvitee);
+      });
+
       it('should accept valid phone with isInternalNumber', async () => {
         sandbox.spy(MembersUtil, 'isInvalidInvitee');
 
@@ -190,6 +210,22 @@ describe('plugin-meetings', () => {
         assert.isFalse(MembersUtil.isInvalidInvitee({phoneNumber: '18578675309', isInternalNumber: true}));
         assert.isTrue(MembersUtil.isInvalidInvitee({phoneNumber: '+8618578675309', isInternalNumber: true}));
       });
+
+      it('should not crash if params is undefined', async () => {
+        sandbox.spy(MembersUtil, 'isInvalidInvitee');
+
+        const members = createMembers({url: true});
+        
+        try {
+          await members.addMember(undefined);
+        } catch (err) {
+          assert.instanceOf(err, ParameterError);
+
+          assert.equal(err.message, 'The invitee must be defined with either a valid email, emailAddress or phoneNumber property.');
+        }
+              
+        assert.called(MembersUtil.isInvalidInvitee);
+      });
     });
 
     describe('#admitMembers', () => {