@webex/plugin-meetings 3.0.0-beta.174 → 3.0.0-beta.176

package/dist/types/annotation/annotation.types.d.ts

@@ -33,7 +33,6 @@ interface IAnnotationChannel {
     acceptRequest: (approval: any) => undefined | Promise<void>;
     declineRequest: (approval: any) => undefined | Promise<void>;
     closeAnnotation: (requestData: RequestData) => undefined | Promise<void>;
-    changeAnnotationOptions: (remoteShareUrl: any, annotationInfo: any) => undefined | Promise<void>;
     approveAnnotation: (requestData: RequestData) => undefined | Promise<void>;
     cancelApproveAnnotation: (requestData: RequestData, approval: any) => undefined | Promise<void>;
     sendStrokeData: (strokeData: StrokeData) => void;

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

@@ -106,13 +106,6 @@ declare class AnnotationChannel extends WebexPlugin implements IAnnotationChanne
      * @returns {void}
      */
     sendStrokeData: (strokeData: StrokeData) => void;
-    /**
-     * Change annotation options
-     * @param {remoteShareUrl} remoteShareUrl
-     * @param {annotationInfo} annotationInfo
-     * @returns {Promise}
-     */
-    changeAnnotationOptions(remoteShareUrl: any, annotationInfo: any): any;
     /**
      * private encrypted the strokes data
      * @param {string} encryptedContent

package/dist/types/constants.d.ts

@@ -218,6 +218,7 @@ export declare const EVENT_TRIGGERS: {
     MEETING_BREAKOUTS_PRE_ASSIGNMENTS_UPDATE: string;
     MEETING_INTERPRETATION_UPDATE: string;
     MEETING_INTERPRETATION_SUPPORT_LANGUAGES_UPDATE: string;
+    MEETING_INTERPRETATION_HANDOFF_REQUESTS_ARRIVED: string;
     MEMBERS_UPDATE: string;
     MEMBERS_CLEAR: string;
     MEMBERS_CONTENT_UPDATE: string;
@@ -463,7 +464,15 @@ export declare const BREAKOUTS: {
 export declare const INTERPRETATION: {
     EVENTS: {
         SUPPORT_LANGUAGES_UPDATE: string;
+        HANDOFF_REQUESTS_ARRIVED: string;
     };
+    ACTION_TYPE: {
+        OFFERED: string;
+        ACCEPTED: string;
+        REQUESTED: string;
+        DECLINED: string;
+    };
+    RESOURCE_TYPE: string;
 };
 export declare const LOCUSINFO: {
     EVENTS: {

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

@@ -158,7 +158,11 @@ export declare enum ScreenShareFloorStatus {
  * @instance
  * @type {Object}
  * @property {Boolean} memberId id of the meeting member that started screen share
+ * @property {String}  url of this content share
+ * @property {String}  shareInstanceId of this content share
+ * @property {Object}  annotation Info of this content share
  * @memberof Meeting
+ *
  */
 /**
  * Meeting Stopped Sharing Remote Event

package/package.json

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

package/src/annotation/annotation.types.ts

@@ -38,8 +38,6 @@ interface IAnnotationChannel {
   acceptRequest: (approval) => undefined | Promise<void>;
   declineRequest: (approval) => undefined | Promise<void>;
   closeAnnotation: (requestData: RequestData) => undefined | Promise<void>;
-  // change annotation privilege
-  changeAnnotationOptions: (remoteShareUrl, annotationInfo) => undefined | Promise<void>;
   // === below is for attendee
   approveAnnotation: (requestData: RequestData) => undefined | Promise<void>;
   cancelApproveAnnotation: (requestData: RequestData, approval) => undefined | Promise<void>;

package/src/annotation/index.ts

@@ -280,21 +280,6 @@ class AnnotationChannel extends WebexPlugin implements IAnnotationChannel {
     );
   };
 
-  /**
-   * Change annotation options
-   * @param {remoteShareUrl} remoteShareUrl
-   * @param {annotationInfo} annotationInfo
-   * @returns {Promise}
-   */
-  public changeAnnotationOptions(remoteShareUrl, annotationInfo) {
-    // @ts-ignore
-    return this.request({
-      method: HTTP_VERBS.PATCH,
-      url: remoteShareUrl,
-      body: annotationInfo,
-    });
-  }
-
   /**
    * private encrypted the strokes data
    * @param {string} encryptedContent

package/src/constants.ts

@@ -319,6 +319,7 @@ export const EVENT_TRIGGERS = {
   MEETING_BREAKOUTS_PRE_ASSIGNMENTS_UPDATE: 'meeting:breakouts:preAssignmentsUpdate',
   MEETING_INTERPRETATION_UPDATE: 'meeting:interpretation:update',
   MEETING_INTERPRETATION_SUPPORT_LANGUAGES_UPDATE: 'meeting:interpretation:supportLanguagesUpdate',
+  MEETING_INTERPRETATION_HANDOFF_REQUESTS_ARRIVED: 'meeting:interpretation:handoffRequestsArrived',
   MEMBERS_UPDATE: 'members:update',
   MEMBERS_CLEAR: 'members:clear',
   MEMBERS_CONTENT_UPDATE: 'members:content:update',
@@ -597,7 +598,15 @@ export const BREAKOUTS = {
 export const INTERPRETATION = {
   EVENTS: {
     SUPPORT_LANGUAGES_UPDATE: 'SUPPORT_LANGUAGES_UPDATE',
+    HANDOFF_REQUESTS_ARRIVED: 'HANDOFF_REQUESTS_ARRIVED',
   },
+  ACTION_TYPE: {
+    OFFERED: 'OFFERED',
+    ACCEPTED: 'ACCEPTED',
+    REQUESTED: 'REQUESTED',
+    DECLINED: 'DECLINED',
+  },
+  RESOURCE_TYPE: 'SiHandover',
 };
 
 export const LOCUSINFO = {

package/src/interpretation/README.md

@@ -45,7 +45,16 @@ The following are methods available to the interpreters of a meeting.
 //Change direction of interpretation for an interpreter participant
 interpretation.changeDirection();
 
-//Handoff between interpreters, will implement them later
-interpretation.handoff(participantId)
+//Handoff between interpreters, input paramerter participantId is the target to handoff
+interpretation.handoffInterpreter(participantId);
+
+//in-active interpreter request to handoff to self
+interpretation.requestHandoff();
+
+//accept the request of handoff, input paramter url is from last approval event which generate by server side
+interpretation.acceptRequest(url);
+
+//decline the request of handoff, input paramter url is from last approval event which generate by server side
+interpretation.declineRequest(url);
 
 ```

package/src/interpretation/index.ts

@@ -18,6 +18,7 @@ const SimultaneousInterpretation = WebexPlugin.extend({
 
   props: {
     locusUrl: 'string', // appears current meeting's locus url
+    approvalUrl: 'string', // appears current meeting's approval url for handoff between interpreters
     originalLanguage: 'string', // appears current meeting's original language
     sourceLanguage: 'string', // appears self interpreter's source language
     targetLanguage: 'string', // appears self interpreter's target language
@@ -27,18 +28,18 @@ const SimultaneousInterpretation = WebexPlugin.extend({
     selfParticipantId: 'string', // appears the self participant id
     canManageInterpreters: 'boolean', // appears the ability to manage interpreters
     supportLanguages: 'array', // appears the support languages
-    siEnabled: 'boolean', // appears the meeting enabled SI
+    hostSIEnabled: 'boolean', // appears the meeting host feature of SI enabled
   },
   derived: {
     shouldQuerySupportLanguages: {
       cache: false,
-      deps: ['canManageInterpreters', 'siEnabled'],
+      deps: ['canManageInterpreters', 'hostSIEnabled'],
       /**
        * Returns should query support languages or not
        * @returns {boolean}
        */
       fn() {
-        return !!(this.canManageInterpreters && this.siEnabled);
+        return !!(this.canManageInterpreters && this.hostSIEnabled);
       },
     },
   },
@@ -52,6 +53,7 @@ const SimultaneousInterpretation = WebexPlugin.extend({
         this.querySupportLanguages();
       }
     });
+    this.listenToHandoffRequests();
   },
 
   /**
@@ -69,6 +71,14 @@ const SimultaneousInterpretation = WebexPlugin.extend({
   locusUrlUpdate(locusUrl) {
     this.set('locusUrl', locusUrl);
   },
+  /**
+   * Update the approval url for handoff
+   * @param {string} approvalUrl // approval url
+   * @returns {void}
+   */
+  approvalUrlUpdate(approvalUrl) {
+    this.set('approvalUrl', approvalUrl);
+  },
   /**
    * Update whether self has capability to manage interpreters (only host can manage it)
    * @param {boolean} canManageInterpreters
@@ -77,13 +87,20 @@ const SimultaneousInterpretation = WebexPlugin.extend({
   updateCanManageInterpreters(canManageInterpreters) {
     this.set('canManageInterpreters', canManageInterpreters);
   },
+  /**
+   * Update whether the meeting's host si is enabled or not
+   * @param {boolean} hostSIEnabled
+   * @returns {void}
+   */
+  updateHostSIEnabled(hostSIEnabled) {
+    this.set('hostSIEnabled', hostSIEnabled);
+  },
   /**
    * Update the interpretation languages channels which user can choose to subscribe
    * @param {Object} interpretation
    * @returns {void}
    */
   updateInterpretation(interpretation) {
-    this.set('siEnabled', !!interpretation);
     this.siLanguages.set(interpretation?.siLanguages || []);
   },
   /**
@@ -177,6 +194,125 @@ const SimultaneousInterpretation = WebexPlugin.extend({
       throw error;
     });
   },
+  /**
+   * Sets up a listener for handoff requests from mercury
+   * @returns {void}
+   */
+  listenToHandoffRequests() {
+    this.listenTo(this.webex.internal.mercury, 'event:locus.approval_request', (event) => {
+      if (event?.data?.approval?.resourceType === INTERPRETATION.RESOURCE_TYPE) {
+        const {receivers, initiator, actionType, url} = event.data.approval;
+        const receiverId = receivers?.[0]?.participantId;
+        const isReceiver = !!receiverId && receiverId === this.selfParticipantId;
+        const senderId = initiator?.participantId;
+        const isSender = !!senderId && senderId === this.selfParticipantId;
+        if (!isReceiver && !isSender) {
+          return;
+        }
+        this.trigger(INTERPRETATION.EVENTS.HANDOFF_REQUESTS_ARRIVED, {
+          actionType,
+          isReceiver,
+          isSender,
+          senderId,
+          receiverId,
+          url,
+        });
+      }
+    });
+  },
+  /**
+   * handoff the active interpreter role to another interpreter in same group, only the interpreter is allowed to call this api
+   * @param {string} participantId the participant id you want to hand off
+   * @returns {Promise}
+   */
+  handoffInterpreter(participantId) {
+    if (!participantId) {
+      return Promise.reject(new Error('Missing target participant id'));
+    }
+    if (!this.approvalUrl) {
+      return Promise.reject(new Error('Missing approval url'));
+    }
+
+    return this.request({
+      method: HTTP_VERBS.POST,
+      uri: this.approvalUrl,
+      body: {
+        actionType: INTERPRETATION.ACTION_TYPE.OFFERED,
+        resourceType: INTERPRETATION.RESOURCE_TYPE,
+        receivers: [
+          {
+            participantId,
+          },
+        ],
+      },
+    }).catch((error) => {
+      LoggerProxy.logger.error('Meeting:interpretation#handoffInterpreter failed', error);
+      throw error;
+    });
+  },
+  /**
+   * the in-active interpreter request to hand off the active role to self
+   * @returns {Promise}
+   */
+  requestHandoff() {
+    if (!this.approvalUrl) {
+      return Promise.reject(new Error('Missing approval url'));
+    }
+
+    return this.request({
+      method: HTTP_VERBS.POST,
+      uri: this.approvalUrl,
+      body: {
+        actionType: INTERPRETATION.ACTION_TYPE.REQUESTED,
+        resourceType: INTERPRETATION.RESOURCE_TYPE,
+      },
+    }).catch((error) => {
+      LoggerProxy.logger.error('Meeting:interpretation#requestHandoff failed', error);
+      throw error;
+    });
+  },
+  /**
+   * accept the request of handoff
+   * @param {String} url the url get from last approval event
+   * @returns {Promise}
+   */
+  acceptRequest(url) {
+    if (!url) {
+      return Promise.reject(new Error('Missing the url to accept'));
+    }
+
+    return this.request({
+      method: HTTP_VERBS.PUT,
+      uri: url,
+      body: {
+        actionType: INTERPRETATION.ACTION_TYPE.ACCEPTED,
+      },
+    }).catch((error) => {
+      LoggerProxy.logger.error('Meeting:interpretation#acceptRequest failed', error);
+      throw error;
+    });
+  },
+  /**
+   * decline the request of handoff
+   * @param {String} url the url get from last approval event
+   * @returns {Promise}
+   */
+  declineRequest(url) {
+    if (!url) {
+      return Promise.reject(new Error('Missing the url to decline'));
+    }
+
+    return this.request({
+      method: HTTP_VERBS.PUT,
+      uri: url,
+      body: {
+        actionType: INTERPRETATION.ACTION_TYPE.DECLINED,
+      },
+    }).catch((error) => {
+      LoggerProxy.logger.error('Meeting:interpretation#declineRequest failed', error);
+      throw error;
+    });
+  },
 });
 
 export default SimultaneousInterpretation;

package/src/meeting/index.ts

@@ -295,7 +295,11 @@ export enum ScreenShareFloorStatus {
  * @instance
  * @type {Object}
  * @property {Boolean} memberId id of the meeting member that started screen share
+ * @property {String}  url of this content share
+ * @property {String}  shareInstanceId of this content share
+ * @property {Object}  annotation Info of this content share
  * @memberof Meeting
+ *
  */
 
 /**
@@ -1608,6 +1612,21 @@ export default class Meeting extends StatelessWebexPlugin {
         EVENT_TRIGGERS.MEETING_INTERPRETATION_SUPPORT_LANGUAGES_UPDATE
       );
     });
+
+    this.simultaneousInterpretation.on(
+      INTERPRETATION.EVENTS.HANDOFF_REQUESTS_ARRIVED,
+      (payload) => {
+        Trigger.trigger(
+          this,
+          {
+            file: 'meeting/index',
+            function: 'setUpInterpretationListener',
+          },
+          EVENT_TRIGGERS.MEETING_INTERPRETATION_HANDOFF_REQUESTS_ARRIVED,
+          payload
+        );
+      }
+    );
   }
 
   /**
@@ -2218,6 +2237,7 @@ export default class Meeting extends StatelessWebexPlugin {
                   memberId: contentShare.beneficiaryId,
                   url: contentShare.url,
                   shareInstanceId: contentShare.shareInstanceId,
+                  annotationInfo: contentShare.annotation,
                 }
               );
             };
@@ -2306,6 +2326,7 @@ export default class Meeting extends StatelessWebexPlugin {
             memberId: contentShare.beneficiaryId,
             url: contentShare.url,
             shareInstanceId: contentShare.shareInstanceId,
+            annotationInfo: contentShare.annotation,
           }
         );
         this.members.locusMediaSharesUpdate(payload);
@@ -2374,6 +2395,7 @@ export default class Meeting extends StatelessWebexPlugin {
       this.recordingController.setSessionId(this.locusInfo?.fullState?.sessionId);
       this.breakouts.breakoutServiceUrlUpdate(payload?.services?.breakout?.url);
       this.annotation.approvalUrlUpdate(payload?.services?.approval?.url);
+      this.simultaneousInterpretation.approvalUrlUpdate(payload?.services?.approval?.url);
     });
   }
 
@@ -3157,6 +3179,9 @@ export default class Meeting extends StatelessWebexPlugin {
       // Need to populate environment when sending CA event
       this.environment = locusMeetingObject?.info.channel || webexMeetingInfo?.channel;
     }
+    this.simultaneousInterpretation.updateHostSIEnabled(
+      !!webexMeetingInfo?.meetingSiteSetting?.enableHostInterpreterControlSI
+    );
   }
 
   /**

package/test/unit/spec/annotation/index.ts

@@ -343,24 +343,6 @@ describe('live-annotation', () => {
         });
       });
 
-      describe('change annotation info by presenter', () => {
-        it('makes change annotation options as expected', async() => {
-          const options =  { annotationInfo:{
-              version: '1',
-              policy: 'AnnotationNotAllowed',
-          }};
-
-          const remoteShareUrl = 'remoteShareUrl';
-          const result = await annotationService.changeAnnotationOptions(remoteShareUrl,options);
-          assert.calledOnceWithExactly(webex.request, {
-              method: 'PATCH',
-              url: 'remoteShareUrl',
-              body: {annotationInfo: { version: '1', policy: 'AnnotationNotAllowed' }}
-          });
-          assert.equal(result, 'REQUEST_RETURN_VALUE')
-        });
-      });
-
 
 
       describe('close annotation', () => {