@webex/plugin-meetings 3.8.0-next.73 → 3.8.0-next.75

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

@@ -880,6 +880,17 @@ export default class Meeting extends StatelessWebexPlugin {
     cancelPhoneInvite(invitee: {
         phoneNumber: string;
     }): any;
+    /**
+     * Cancel an SIP call invitation made during a meeting
+     * @param {Object} invitee
+     * @param {String} invitee.memberId
+     * @returns {Promise} see #members.cancelSIPInvite
+     * @public
+     * @memberof Meeting
+     */
+    cancelSIPInvite(invitee: {
+        memberId: string;
+    }): any;
     /**
      * Admit the guest(s) to the call once they are waiting.
      * If the host/cohost is in a breakout session, the locus url

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

@@ -251,6 +251,13 @@ export default class Members extends StatelessWebexPlugin {
      * @memberof Members
      */
     cancelPhoneInvite(invitee: any): any;
+    /**
+     * Cancels an SIP call to the associated meeting
+     * @param {String} invitee
+     * @returns {Promise}
+     * @memberof Members
+     */
+    cancelSIPInvite(invitee: any): any;
     /**
      * Admits waiting members (invited guests to meeting)
      * @param {Array} memberIds

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

@@ -130,4 +130,11 @@ export default class MembersRequest extends StatelessWebexPlugin {
      * @memberof MembersRequest
      */
     cancelPhoneInvite(options: any): Promise<any>;
+    /**
+     * @param {Object} options with format of {invitee: object, locusUrl: string}
+     * @returns {Promise}
+     * @throws {Error} if the options are not valid and complete, must have invitee with memberId AND locusUrl
+     * @memberof MembersRequest
+     */
+    cancelSIPInvite(options: any): Promise<any>;
 }

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

@@ -228,5 +228,19 @@ declare const MembersUtil: {
             }[];
         };
     };
+    cancelSIPInviteOptions: (invitee: any, locusUrl: any) => {
+        invitee: any;
+        locusUrl: any;
+    };
+    generateCancelSIPInviteRequestParams: (options: any) => {
+        method: string;
+        uri: any;
+        body: {
+            actionType: string;
+            invitees: {
+                address: any;
+            }[];
+        };
+    };
 };
 export default MembersUtil;

package/dist/webinar/index.js

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

package/src/constants.ts

@@ -381,6 +381,7 @@ export const EVENT_TRIGGERS = {
   MEETING_STOPPED_RECEIVING_TRANSCRIPTION: 'meeting:receiveTranscription:stopped',
   MEETING_MANUAL_CAPTION_UPDATED: 'meeting:manualCaptionControl:updated',
   MEETING_CAPTION_RECEIVED: 'meeting:caption-received',
+  MEETING_PARTICIPANT_REASON_CHANGED: 'meeting:participant-reason-changed',
 };
 
 export const EVENT_TYPES = {
@@ -743,6 +744,7 @@ export const LOCUSINFO = {
     MEDIA_INACTIVITY: 'MEDIA_INACTIVITY',
     LINKS_SERVICES: 'LINKS_SERVICES',
     LINKS_RESOURCES: 'LINKS_RESOURCES',
+    PARTICIPANT_REASON_CHANGED: 'PARTICIPANT_REASON_CHANGED',
   },
 };
 

package/src/locus-info/index.ts

@@ -1,4 +1,4 @@
-import {isEqual, assignWith, cloneDeep, isEmpty} from 'lodash';
+import {isEqual, assignWith, cloneDeep, isEmpty, forEach} from 'lodash';
 
 import LoggerProxy from '../common/logs/logger-proxy';
 import EventsScope from '../common/events/events-scope';
@@ -784,6 +784,23 @@ export default class LocusInfo extends EventsScope {
         isReplace,
       }
     );
+
+    if (participants && Array.isArray(participants) && participants.length > 0) {
+      for (const participant of participants) {
+        if (participant && participant?.reason === 'FAILURE') {
+          this.emitScoped(
+            {
+              file: 'locus-info',
+              function: 'updateParticipants',
+            },
+            LOCUSINFO.EVENTS.PARTICIPANT_REASON_CHANGED,
+            {
+              displayName: participant?.person?.primaryDisplayString,
+            }
+          );
+        }
+      }
+    }
   }
 
   /**

package/src/meeting/index.ts

@@ -2637,6 +2637,19 @@ export default class Meeting extends StatelessWebexPlugin {
     this.locusInfo.on(EVENTS.LOCUS_INFO_UPDATE_PARTICIPANTS, (payload) => {
       this.members.locusParticipantsUpdate(payload);
     });
+    this.locusInfo.on(LOCUSINFO.EVENTS.PARTICIPANT_REASON_CHANGED, (payload) => {
+      Trigger.trigger(
+        this,
+        {
+          file: 'meeting/index',
+          function: 'setUpLocusParticipantsListener',
+        },
+        EVENT_TRIGGERS.MEETING_PARTICIPANT_REASON_CHANGED,
+        {
+          payload,
+        }
+      );
+    });
   }
 
   /**
@@ -3803,6 +3816,18 @@ export default class Meeting extends StatelessWebexPlugin {
     return this.members.cancelPhoneInvite(invitee);
   }
 
+  /**
+   * Cancel an SIP call invitation made during a meeting
+   * @param {Object} invitee
+   * @param {String} invitee.memberId
+   * @returns {Promise} see #members.cancelSIPInvite
+   * @public
+   * @memberof Meeting
+   */
+  public cancelSIPInvite(invitee: {memberId: string}) {
+    return this.members.cancelSIPInvite(invitee);
+  }
+
   /**
    * Admit the guest(s) to the call once they are waiting.
    * If the host/cohost is in a breakout session, the locus url

package/src/members/index.ts

@@ -773,6 +773,28 @@ export default class Members extends StatelessWebexPlugin {
     return this.membersRequest.cancelPhoneInvite(options);
   }
 
+  /**
+   * Cancels an SIP call to the associated meeting
+   * @param {String} invitee
+   * @returns {Promise}
+   * @memberof Members
+   */
+  cancelSIPInvite(invitee: any) {
+    if (!this.locusUrl) {
+      return Promise.reject(
+        new ParameterError('The associated locus url for this meeting object must be defined.')
+      );
+    }
+    if (!invitee?.memberId) {
+      return Promise.reject(
+        new ParameterError('The invitee must be defined with a memberId property.')
+      );
+    }
+    const options = MembersUtil.cancelSIPInviteOptions(invitee, this.locusUrl);
+
+    return this.membersRequest.cancelSIPInvite(options);
+  }
+
   /**
    * Admits waiting members (invited guests to meeting)
    * @param {Array} memberIds

package/src/members/request.ts

@@ -278,4 +278,22 @@ export default class MembersRequest extends StatelessWebexPlugin {
 
     return this.locusDeltaRequest(requestParams);
   }
+
+  /**
+   * @param {Object} options with format of {invitee: object, locusUrl: string}
+   * @returns {Promise}
+   * @throws {Error} if the options are not valid and complete, must have invitee with memberId AND locusUrl
+   * @memberof MembersRequest
+   */
+  cancelSIPInvite(options: any) {
+    if (!options?.invitee?.memberId || !options?.locusUrl) {
+      throw new ParameterError(
+        'invitee must be passed and the associated locus url for this meeting object must be defined.'
+      );
+    }
+
+    const requestParams = MembersUtil.generateCancelSIPInviteRequestParams(options);
+
+    return this.locusDeltaRequest(requestParams);
+  }
 }

package/src/members/util.ts

@@ -367,6 +367,29 @@ const MembersUtil = {
 
     return requestParams;
   },
+
+  cancelSIPInviteOptions: (invitee, locusUrl) => ({
+    invitee,
+    locusUrl,
+  }),
+
+  generateCancelSIPInviteRequestParams: (options) => {
+    const body = {
+      actionType: _REMOVE_,
+      invitees: [
+        {
+          address: options.invitee.memberId,
+        },
+      ],
+    };
+    const requestParams = {
+      method: HTTP_VERBS.PUT,
+      uri: options.locusUrl,
+      body,
+    };
+
+    return requestParams;
+  },
 };
 
 export default MembersUtil;

package/test/unit/spec/locus-info/index.js

@@ -825,6 +825,32 @@ describe('plugin-meetings', () => {
 
         assert.isTrue(locusInfo.deltaParticipants.length === 0);
       });
+
+      it('should call with participant display name', () => {
+        const failureParticipant = [
+          {
+            person: {
+              id: 5678,
+              primaryDisplayString: 'Test User',
+            },
+            reason: 'FAILURE',
+          },
+        ];
+
+        locusInfo.emitScoped = sinon.stub();
+        locusInfo.updateParticipants(failureParticipant);
+        assert.calledWith(
+          locusInfo.emitScoped,
+          {
+            file: 'locus-info',
+            function: 'updateParticipants',
+          },
+          LOCUSINFO.EVENTS.PARTICIPANT_REASON_CHANGED,
+          {
+            displayName: 'Test User',
+          }
+        );
+      })
     });
 
     describe('#updateSelf', () => {

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

@@ -614,6 +614,22 @@ describe('plugin-meetings', () => {
           assert.calledWith(meeting.members.cancelPhoneInvite, uuid1);
         });
       });
+      describe('#cancelSIPInvite', () => {
+        it('should have #cancelSIPInvite', () => {
+          assert.exists(meeting.cancelSIPInvite);
+        });
+        beforeEach(() => {
+          meeting.members.cancelSIPInvite = sinon.stub().returns(Promise.resolve(test1));
+        });
+        it('should proxy members #cancelSIPInvite and return a promise', async () => {
+          const cancel = meeting.cancelSIPInvite({memberId: uuid1});
+
+          assert.exists(cancel.then);
+          await cancel;
+          assert.calledOnce(meeting.members.cancelSIPInvite);
+          assert.calledWith(meeting.members.cancelSIPInvite, {memberId: uuid1});
+        });
+      });
       describe('#admit', () => {
         it('should have #admit', () => {
           assert.exists(meeting.admit);

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

@@ -342,6 +342,32 @@ describe('plugin-meetings', () => {
       });
     });
 
+    describe('#cancelSIPInvite', () => {
+      const memberId = uuid.v4();
+      it('should invoke cancelSIPInviteOptions from MembersUtil when cancelSIPInvite is called with valid params', async () => {
+        sandbox.spy(MembersUtil, 'cancelSIPInviteOptions');
+
+        const members = createMembers({url: url1});
+
+        await members.cancelSIPInvite({memberId});
+        assert.calledOnce(MembersUtil.cancelSIPInviteOptions);
+      });
+
+      it('should throw a rejection if there is no locus url', async () => {
+        const members = createMembers({url: false});
+
+        assert.isRejected(members.cancelSIPInvite({memberId}));
+      });
+      
+      it('should throw a rejection if memberId is not provided', async () => {
+        const members = createMembers({url: url1});
+
+        assert.isRejected(members.cancelSIPInvite({}));
+        assert.isRejected(members.cancelSIPInvite({memberId: null}));
+        assert.isRejected(members.cancelSIPInvite({memberId: undefined}));
+      });
+    });
+
     describe('#assignRoles', () => {
       const fakeRoles = [
         {type: 'PRESENTER', hasRole: true},

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

@@ -221,6 +221,29 @@ describe('plugin-meetings', () => {
       });
     });
 
+    describe('#cancelSIPInvite', () => {
+      const memberId = uuid.v4();
+      it('sends a PUT to the locus endpoint', async () => {
+        const options = {
+          invitee: {
+            memberId,
+          },
+          locusUrl: url1,
+        };
+
+        await membersRequest.cancelSIPInvite(options);
+
+        checkRequest({
+          method: 'PUT',
+          uri: url1,
+          body: {
+            actionType: 'REMOVE',
+            invitees: [{address: memberId}],
+          },
+        });
+      });
+    });
+
     describe('#assignRolesMember', () => {
       it('sends a assignRolesMember PATCH to the locus endpoint', async () => {
         const locusUrl = url1;

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

@@ -390,5 +390,47 @@ describe('plugin-meetings', () => {
         });
       });
     });
+
+    describe('#cancelSIPInviteOptions', () => {
+      it('returns the correct options', () => {
+        const locusUrl = 'TestLocusUrl';
+        const memberId = 'test';
+        const invitee = {memberId};
+
+        assert.deepEqual(
+          MembersUtil.cancelSIPInviteOptions(
+            invitee,
+            locusUrl
+          ),
+          {
+            invitee,
+            locusUrl,
+          }
+        );
+      });
+    });
+
+    describe('#generateCancelSIPInviteRequestParams', () => {
+      it('returns the correct params', () => {
+        const locusUrl = 'TestLocusUrl';
+        const memberId = 'test';
+        const options = {
+          locusUrl,
+          invitee: {memberId}
+        };
+        const body = {
+          actionType: 'REMOVE',
+          invitees: [{address: options.invitee.memberId}],
+        };
+
+        const uri = options.locusUrl;
+
+        assert.deepEqual(MembersUtil.generateCancelSIPInviteRequestParams(options), {
+          method: HTTP_VERBS.PUT,
+          uri,
+          body,
+        });
+      });
+    });
   });
 });