@webex/plugin-meetings 3.0.0-beta.4 → 3.0.0-beta.400

package/src/meeting/request.type.ts

@@ -0,0 +1,13 @@
+import {Reaction} from '../reactions/reactions.type';
+
+export type SendReactionOptions = {
+  reactionChannelUrl: string;
+  reaction: Reaction;
+  participantId: string;
+};
+
+export type ToggleReactionsOptions = {
+  enable: boolean;
+  locusUrl: string;
+  requestingParticipantId: string;
+};

package/src/meeting/{state.js → state.ts}

@@ -13,9 +13,11 @@ const MeetingStateMachine = {
    * @param {Meeting} meetingRef A reference to a meeting instance
    * @returns {StateMachine}
    */
-  create(meetingRef) {
+  create(meetingRef: any) {
     if (!meetingRef) {
-      throw new ParameterError('You must initialize the meeting state machine with a meeting reference.');
+      throw new ParameterError(
+        'You must initialize the meeting state machine with a meeting reference.'
+      );
     }
 
     return new StateMachine({
@@ -24,27 +26,36 @@ const MeetingStateMachine = {
         // when ringing a meeting, it must be first IDLE, because all other states are invalid, it transitions to the RINGING state
         {
           name: MEETING_STATE_MACHINE.TRANSITIONS.RING,
-          from: [MEETING_STATE_MACHINE.STATES.IDLE, MEETING_STATE_MACHINE.STATES.ERROR, MEETING_STATE_MACHINE.STATES.JOINED],
-          to: MEETING_STATE_MACHINE.STATES.RINGING
+          from: [
+            MEETING_STATE_MACHINE.STATES.IDLE,
+            MEETING_STATE_MACHINE.STATES.ERROR,
+            MEETING_STATE_MACHINE.STATES.JOINED,
+          ],
+          to: MEETING_STATE_MACHINE.STATES.RINGING,
         },
         // when joining a meeting, it must be from the RINGING or IDLE state, transitions to JOINED state, 1:1 will go to RINGING,
         // others will go straight to JOINED with this transition
         {
           name: MEETING_STATE_MACHINE.TRANSITIONS.JOIN,
-          from: [MEETING_STATE_MACHINE.STATES.JOINED, MEETING_STATE_MACHINE.STATES.IDLE, MEETING_STATE_MACHINE.STATES.RINGING, MEETING_STATE_MACHINE.STATES.ERROR],
-          to: MEETING_STATE_MACHINE.STATES.JOINED
+          from: [
+            MEETING_STATE_MACHINE.STATES.JOINED,
+            MEETING_STATE_MACHINE.STATES.IDLE,
+            MEETING_STATE_MACHINE.STATES.RINGING,
+            MEETING_STATE_MACHINE.STATES.ERROR,
+          ],
+          to: MEETING_STATE_MACHINE.STATES.JOINED,
         },
         // signify that ringing has stopped and somebody else answered, move state to DECLINED, ANSWERED
         {
           name: MEETING_STATE_MACHINE.TRANSITIONS.REMOTE,
           from: [MEETING_STATE_MACHINE.STATES.JOINED, MEETING_STATE_MACHINE.STATES.ERROR],
           /**
-         * @param {Object} remote
-         * @param {Boolean} remote.remoteAnswered
-         * @param {Boolean} remote.remoteDeclined
-         * @returns {String}
-         */
-          to(remote) {
+           * @param {Object} remote
+           * @param {Boolean} remote.remoteAnswered
+           * @param {Boolean} remote.remoteDeclined
+           * @returns {String}
+           */
+          to(remote: {remoteAnswered: boolean; remoteDeclined: boolean}) {
             // other user answered the call
             if (remote.remoteAnswered) {
               return MEETING_STATE_MACHINE.STATES.ANSWERED;
@@ -56,7 +67,7 @@ const MeetingStateMachine = {
 
             // default
             return MEETING_STATE_MACHINE.STATES.ERROR;
-          }
+          },
         },
         // when leaving a meeting it must be from either the RINGING, JOINED, or ERROR states, and transitions it to the ENDED state
         {
@@ -67,9 +78,9 @@ const MeetingStateMachine = {
             MEETING_STATE_MACHINE.STATES.JOINED,
             MEETING_STATE_MACHINE.STATES.ANSWERED,
             MEETING_STATE_MACHINE.STATES.DECLINED,
-            MEETING_STATE_MACHINE.STATES.ERROR
+            MEETING_STATE_MACHINE.STATES.ERROR,
           ],
-          to: MEETING_STATE_MACHINE.STATES.ENDED
+          to: MEETING_STATE_MACHINE.STATES.ENDED,
         },
         {
           name: MEETING_STATE_MACHINE.TRANSITIONS.END,
@@ -79,33 +90,33 @@ const MeetingStateMachine = {
             MEETING_STATE_MACHINE.STATES.JOINED,
             MEETING_STATE_MACHINE.STATES.ANSWERED,
             MEETING_STATE_MACHINE.STATES.DECLINED,
-            MEETING_STATE_MACHINE.STATES.ERROR
+            MEETING_STATE_MACHINE.STATES.ERROR,
           ],
-          to: MEETING_STATE_MACHINE.STATES.ENDED
+          to: MEETING_STATE_MACHINE.STATES.ENDED,
         },
         {
           name: MEETING_STATE_MACHINE.TRANSITIONS.DECLINE,
           from: [MEETING_STATE_MACHINE.STATES.RINGING, MEETING_STATE_MACHINE.STATES.ERROR],
-          to: MEETING_STATE_MACHINE.STATES.ENDED
+          to: MEETING_STATE_MACHINE.STATES.ENDED,
         },
         // transition from ANY state to ERROR state
         {
           name: MEETING_STATE_MACHINE.TRANSITIONS.FAIL,
           from: '*',
-          to: MEETING_STATE_MACHINE.STATES.ERROR
+          to: MEETING_STATE_MACHINE.STATES.ERROR,
         },
         // fail safe, transition from ANY state to IDLE state
         {
           name: MEETING_STATE_MACHINE.TRANSITIONS.RESET,
           from: '*',
-          to: MEETING_STATE_MACHINE.STATES.IDLE
-        }
+          to: MEETING_STATE_MACHINE.STATES.IDLE,
+        },
       ],
       data: {
         /**
          * The meeting instance to execute all state changes on
          */
-        meeting: meetingRef
+        meeting: meetingRef,
       },
       methods: {
         /**
@@ -114,18 +125,18 @@ const MeetingStateMachine = {
          * @param {Object} stop -- {remoteAnswered: {Boolean}, remoteDeclined: {Boolean}}
          * @returns {Boolean}
          */
-        onRemote(transition, stop) {
+        onRemote(transition: object, stop: object) {
           if (this.meeting) {
             Trigger.trigger(
               this.meeting,
               {
                 file: 'meeting/state',
-                function: 'onRemote'
+                function: 'onRemote',
               },
               EVENT_TRIGGERS.MEETING_RINGING_STOP,
               {
                 id: this.meeting.id,
-                type: stop
+                type: stop,
               }
             );
           }
@@ -136,18 +147,18 @@ const MeetingStateMachine = {
          * @param {String} type -- incoming call === INCOMING / or other meetings have a ring type of JOIN
          * @returns {Boolean}
          */
-        onRing(transition, type) {
+        onRing(transition: object, type: string) {
           if (this.meeting) {
             Trigger.trigger(
               this.meeting,
               {
                 file: 'meeting/state',
-                function: 'onRing'
+                function: 'onRing',
               },
               EVENT_TRIGGERS.MEETING_RINGING,
               {
                 type,
-                id: this.meeting.id
+                id: this.meeting.id,
               }
             );
           }
@@ -158,22 +169,26 @@ const MeetingStateMachine = {
          * @param {Error} error
          * @returns {Boolean}
          */
-        onEnterError(transition, error) {
-          LoggerProxy.logger.error(`Meeting:state#onEnterError --> state->onEnterError#meeting.id: ${this.meeting.id} | Transition '${transition?.transition}' : ${transition?.from} -> ${transition?.to}, with error ${error}. Last states: ${this.history}`);
+        onEnterError(transition: any, error: Error) {
+          LoggerProxy.logger.error(
+            `Meeting:state#onEnterError --> state->onEnterError#meeting.id: ${this.meeting.id} | Transition '${transition?.transition}' : ${transition?.from} -> ${transition?.to}, with error ${error}. Last states: ${this.history}`
+          );
         },
         /**
          * After ANY transition occurs, we want to know what state the meeting moved to for debugging
          * @param {Object} transition
          * @returns {Boolean}
          */
-        onAfterTransition(transition) {
-          LoggerProxy.logger.log(`Meeting:state#onAfterTransition --> state->onAfterTransition#meeting.id: ${this.meeting.id} | Transition '${transition.transition}' : ${transition.from} -> ${transition.to} executed. Last states: ${this.history}`);
-        }
+        onAfterTransition(transition: any) {
+          LoggerProxy.logger.log(
+            `Meeting:state#onAfterTransition --> state->onAfterTransition#meeting.id: ${this.meeting.id} | Transition '${transition.transition}' : ${transition.from} -> ${transition.to} executed. Last states: ${this.history}`
+          );
+        },
       },
       // track the last 25 states entered
-      plugins: [new StateMachineHistory({max: 25})]
+      plugins: [new StateMachineHistory({max: 25})],
     });
-  }
+  },
 };
 
 export default MeetingStateMachine;