@webex/plugin-meetings 2.35.4 → 2.36.1

package/src/meeting/request.ts

@@ -25,6 +25,7 @@ import {
   SEND_DTMF_ENDPOINT,
   _SLIDES_
 } from '../constants';
+import {Reaction} from '../reactions/reactions.type';
 
 /**
  * @class MeetingRequest
@@ -768,4 +769,26 @@ export default class MeetingRequest extends StatelessWebexPlugin {
       uri: keepAliveUrl
     });
   }
+
+  /**
+   * Make a network request to send a reaction.
+   * @param {Object} options
+   * @param {Url} options.reactionChannelUrl
+   * @param {Reaction} options.reaction
+   * @param {string} options.senderID
+   * @returns {Promise}
+   */
+  sendReaction({ reactionChannelUrl, reaction, participantId }: { reactionChannelUrl: string, reaction: Reaction, participantId: string }) {
+    const uri = reactionChannelUrl;
+
+    // @ts-ignore
+    return this.request({
+      method: HTTP_VERBS.POST,
+      uri,
+      body: {
+        sender: {participantId},
+        reaction,
+      }
+    });
+  }
 }

package/src/reactions/reactions.ts

@@ -0,0 +1,104 @@
+import {Reaction, ReactionType, SkinTone, SkinToneType} from './reactions.type';
+
+const Reactions: Record<ReactionType, Reaction> = {
+  smile: {
+    type: 'smile',
+    codepoints: '1F642',
+    shortcodes: ':slightly_smiling_face:'
+  },
+  sad: {
+    type: 'sad',
+    codepoints: '1F625',
+    shortcodes: ':sad_but_relieved_face:',
+  },
+  wow: {
+    type: 'wow',
+    codepoints: '1F62E',
+    shortcodes: ':open_mouth:',
+  },
+  haha: {
+    type: 'haha',
+    codepoints: '1F603',
+    shortcodes: ':smiley:'
+  },
+  celebrate: {
+    type: 'celebrate',
+    codepoints: '1F389',
+    shortcodes: ':party_popper:',
+  },
+  clap: {
+    type: 'clap',
+    codepoints: '1F44F',
+    shortcodes: ':clap:',
+  },
+  thumbs_up: {
+    type: 'thumb_up',
+    codepoints: '1F44D',
+    shortcodes: ':thumbsup:',
+  },
+  thumbs_down: {
+    type: 'thumb_down',
+    codepoints: '1F44E',
+    shortcodes: ':thumbsdown:',
+  },
+  heart: {
+    type: 'heart',
+    codepoints: '2764',
+    shortcodes: ':heart:',
+  },
+  fire: {
+    type: 'fire',
+    codepoints: '1F525',
+    shortcodes: ':fire:',
+  },
+  prayer: {
+    type: 'prayer',
+    codepoints: '1F64F',
+    shortcodes: ':pray:',
+  },
+  speed_up: {
+    type: 'speed_up',
+    codepoints: '1F407',
+    shortcodes: ':rabbit:',
+  },
+  slow_down: {
+    type: 'slow_down',
+    codepoints: '1F422',
+    shortcodes: ':turtle:',
+  }
+};
+
+const SkinTones: Record<SkinToneType, SkinTone> = {
+  normal: {
+    type: 'normal_skin_tone',
+    codepoints: '',
+    shortcodes: '',
+  },
+  light: {
+    type: 'light_skin_tone',
+    codepoints: '1F3FB',
+    shortcodes: ':skin-tone-2:',
+  },
+  medium_light: {
+    type: 'medium_light_skin_tone',
+    codepoints: '1F3FC',
+    shortcodes: ':skin-tone-3:',
+  },
+  medium: {
+    type: 'medium_skin_tone',
+    codepoints: '1F3FD',
+    shortcodes: ':skin-tone-4:',
+  },
+  medium_dark: {
+    type: 'medium_dark_skin_tone',
+    codepoints: '1F3FE',
+    shortcodes: ':skin-tone-5:',
+  },
+  dark: {
+    type: 'dark_skin_tone',
+    codepoints: '1F3FF',
+    shortcodes: ':skin-tone-6:',
+  }
+};
+
+export {Reactions, SkinTones};

package/src/reactions/reactions.type.ts

@@ -0,0 +1,36 @@
+
+export type EmoticonData = {
+  type: string;
+  codepoints?: string;
+  shortcodes?: string;
+}
+
+export type SkinTone = EmoticonData;
+export type Reaction = ReactionData & {
+  tone?: SkinTone;
+}
+
+export enum ReactionType {
+  smile = 'smile',
+  sad = 'sad',
+  wow = 'wow',
+  haha = 'haha',
+  celebrate = 'celebrate',
+  clap = 'clap',
+  thumbs_up = 'thumbs_up',
+  thumbs_down = 'thumbs_down',
+  heart = 'heart',
+  fire = 'fire',
+  prayer = 'prayer',
+  speed_up = 'speed_up',
+  slow_down = 'slow_down',
+}
+
+export enum SkinToneType {
+  normal = 'normal',
+  light = 'light',
+  medium_light = 'medium_light',
+  medium = 'medium',
+  medium_dark = 'medium_dark',
+  dark = 'dark',
+}

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

@@ -715,6 +715,13 @@ describe('plugin-meetings', () => {
               height: {
                 max: 200,
                 ideal: 200
+              },
+              frameRate: {
+                ideal: 15,
+                max: 30
+              },
+              facingMode: {
+                ideal: 'user'
               }
             }
           };
@@ -1420,9 +1427,9 @@ describe('plugin-meetings', () => {
           });
         });
       });
-      describe('#share', () => {
-        it('should have #share', () => {
-          assert.exists(meeting.share);
+      describe('#requestScreenShareFloor', () => {
+        it('should have #requestScreenShareFloor', () => {
+          assert.exists(meeting.requestScreenShareFloor);
         });
         beforeEach(() => {
           meeting.locusInfo.mediaShares = [{name: 'content', url: url1}];
@@ -1430,7 +1437,7 @@ describe('plugin-meetings', () => {
           meeting.meetingRequest.changeMeetingFloor = sinon.stub().returns(Promise.resolve());
         });
         it('should send the share', async () => {
-          const share = meeting.share();
+          const share = meeting.requestScreenShareFloor();
 
           assert.exists(share.then);
           await share;
@@ -3457,22 +3464,34 @@ describe('plugin-meetings', () => {
         sandbox = null;
       });
 
-      describe('#stopFloorRequest', () => {
-        it('should have #stopFloorRequest', () => {
-          assert.exists(meeting.stopFloorRequest);
+      describe('#releaseScreenShareFloor', () => {
+        it('should have #releaseScreenShareFloor', () => {
+          assert.exists(meeting.releaseScreenShareFloor);
         });
         beforeEach(() => {
-          meeting.locusInfo.mediaShares = [{name: 'content', url: url1}];
+          meeting.selfId = 'some self id';
+          meeting.locusInfo.mediaShares = [{name: 'content', url: url1, floor: {beneficiary: {id: meeting.selfId}}}];
           meeting.locusInfo.self = {url: url2};
+          meeting.mediaProperties = {mediaDirection: {sendShare: true}};
           meeting.meetingRequest.changeMeetingFloor = sinon.stub().returns(Promise.resolve());
         });
-        it('should call change meeting floor', async () => {
-          const share = meeting.share();
+        it('should call changeMeetingFloor()', async () => {
+          const share = meeting.releaseScreenShareFloor();
 
           assert.exists(share.then);
           await share;
           assert.calledOnce(meeting.meetingRequest.changeMeetingFloor);
         });
+        it('should not call changeMeetingFloor() if someone else already has the floor', async () => {
+          // change selfId so that it doesn't match the beneficiary id from meeting.locusInfo.mediaShares
+          meeting.selfId = 'new self id';
+
+          const share = meeting.releaseScreenShareFloor();
+
+          assert.exists(share.then);
+          await share;
+          assert.notCalled(meeting.meetingRequest.changeMeetingFloor);
+        });
       });
 
       describe('#setSipUri', () => {
@@ -4003,7 +4022,7 @@ describe('plugin-meetings', () => {
                       if (newPayload.previous.content.beneficiaryId === USER_IDS.ME) {
                         eventTrigger.share.push({
                           eventName: EVENT_TRIGGERS.MEETING_STOPPED_SHARING_LOCAL,
-                          functionName: 'stopFloorRequest'
+                          functionName: 'localShare'
                         });
                       }
                       else if (newPayload.current.content.beneficiaryId === USER_IDS.ME) {
@@ -4054,7 +4073,7 @@ describe('plugin-meetings', () => {
                     if (newPayload.current.content.beneficiaryId === USER_IDS.ME) {
                       eventTrigger.share.push({
                         eventName: EVENT_TRIGGERS.MEETING_STOPPED_SHARING_LOCAL,
-                        functionName: 'stopFloorRequest'
+                        functionName: 'localShare'
                       });
                     }
                     else {
@@ -4073,7 +4092,7 @@ describe('plugin-meetings', () => {
                     if (newPayload.previous.content.beneficiaryId === USER_IDS.ME) {
                       eventTrigger.share.push({
                         eventName: EVENT_TRIGGERS.MEETING_STOPPED_SHARING_LOCAL,
-                        functionName: 'stopFloorRequest'
+                        functionName: 'localShare'
                       });
                     }
                     else if (newPayload.current.content.beneficiaryId === USER_IDS.ME) {
@@ -4116,7 +4135,7 @@ describe('plugin-meetings', () => {
                 if (beneficiaryId === USER_IDS.ME) {
                   eventTrigger.share.push({
                     eventName: EVENT_TRIGGERS.MEETING_STOPPED_SHARING_LOCAL,
-                    functionName: 'stopFloorRequest'
+                    functionName: 'localShare'
                   });
                 }
                 else {
@@ -4582,6 +4601,93 @@ describe('plugin-meetings', () => {
           meeting.stopKeepAlive();
         });
       });
+
+      describe('#sendReaction', () => {
+        it('should have #sendReaction', () => {
+          assert.exists(meeting.sendReaction);
+        });
+
+        beforeEach(() => {
+          meeting.meetingRequest.sendReaction = sinon.stub().returns(Promise.resolve());
+        });
+
+        it('should send reaction with the right data and return a promise', async () => {
+          meeting.locusInfo.controls = {reactions: {reactionChannelUrl: 'Fake URL'}};
+
+          const reactionPromise = meeting.sendReaction('thumbs_down', 'light');
+
+          assert.exists(reactionPromise.then);
+          await reactionPromise;
+          assert.calledOnceWithExactly(meeting.meetingRequest.sendReaction, {
+            reactionChannelUrl: 'Fake URL',
+            reaction: {
+              type: 'thumb_down',
+              codepoints: '1F44E',
+              shortcodes: ':thumbsdown:',
+              tone: {
+                type: 'light_skin_tone',
+                codepoints: '1F3FB',
+                shortcodes: ':skin-tone-2:'
+              }
+            },
+            participantId: meeting.members.selfId,
+          });
+        });
+
+        it('should fail sending a reaction if data channel is undefined', async () => {
+          meeting.locusInfo.controls = {reactions: {reactionChannelUrl: undefined}};
+
+          await assert.isRejected(meeting.sendReaction('thumbs_down', 'light'), Error, 'Error sending reaction, service url not found.');
+
+          assert.notCalled(meeting.meetingRequest.sendReaction);
+        });
+
+        it('should fail sending a reaction if reactionType is invalid ', async () => {
+          meeting.locusInfo.controls = {reactions: {reactionChannelUrl: 'Fake URL'}};
+
+          await assert.isRejected(meeting.sendReaction('invalid_reaction', 'light'), Error, 'invalid_reaction is not a valid reaction.');
+
+          assert.notCalled(meeting.meetingRequest.sendReaction);
+        });
+
+        it('should send a reaction with default skin tone if provided skinToneType is invalid ', async () => {
+          meeting.locusInfo.controls = {reactions: {reactionChannelUrl: 'Fake URL'}};
+
+          const reactionPromise = meeting.sendReaction('thumbs_down', 'invalid_skin_tone');
+
+          assert.exists(reactionPromise.then);
+          await reactionPromise;
+          assert.calledOnceWithExactly(meeting.meetingRequest.sendReaction, {
+            reactionChannelUrl: 'Fake URL',
+            reaction: {
+              type: 'thumb_down',
+              codepoints: '1F44E',
+              shortcodes: ':thumbsdown:',
+              tone: {type: 'normal_skin_tone', codepoints: '', shortcodes: ''}
+            },
+            participantId: meeting.members.selfId,
+          });
+        });
+
+        it('should send a reaction with default skin tone if none provided', async () => {
+          meeting.locusInfo.controls = {reactions: {reactionChannelUrl: 'Fake URL'}};
+
+          const reactionPromise = meeting.sendReaction('thumbs_down');
+
+          assert.exists(reactionPromise.then);
+          await reactionPromise;
+          assert.calledOnceWithExactly(meeting.meetingRequest.sendReaction, {
+            reactionChannelUrl: 'Fake URL',
+            reaction: {
+              type: 'thumb_down',
+              codepoints: '1F44E',
+              shortcodes: ':thumbsdown:',
+              tone: {type: 'normal_skin_tone', codepoints: '', shortcodes: ''}
+            },
+            participantId: meeting.members.selfId,
+          });
+        });
+      });
     });
   });
 });

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

@@ -1,7 +1,6 @@
 import sinon from 'sinon';
 import {assert} from '@webex/test-helper-chai';
 import MockWebex from '@webex/test-helper-mock-webex';
-
 import Meetings from '@webex/plugin-meetings';
 import MeetingRequest from '@webex/plugin-meetings/src/meeting/request';
 
@@ -278,5 +277,30 @@ describe('plugin-meetings', () => {
         assert.equal(requestParams.uri, keepAliveUrl);
       });
     });
+
+    describe('#sendReaction', () => {
+      it('sends request to sendReaction', async () => {
+        const reactionChannelUrl = 'reactionChannelUrl';
+        const participantId = 'participantId';
+        const reaction = {
+          type: 'thumb_down',
+          codepoints: '1F44E',
+          shortcodes: ':thumbsdown:',
+          tone: {type: 'normal_skin_tone', codepoints: '', shortcodes: ''}
+        };
+
+        await meetingsRequest.sendReaction({
+          reactionChannelUrl,
+          reaction,
+          participantId
+        });
+        const requestParams = meetingsRequest.request.getCall(0).args[0];
+
+        assert.equal(requestParams.method, 'POST');
+        assert.equal(requestParams.uri, reactionChannelUrl);
+        assert.equal(requestParams.body.sender.participantId, participantId);
+        assert.equal(requestParams.body.reaction, reaction);
+      });
+    });
   });
 });