@webex/plugin-meetings 3.0.0-beta.14 → 3.0.0-beta.141

package/src/meeting/request.ts

@@ -9,6 +9,7 @@ import LoggerProxy from '../common/logs/logger-proxy';
 import {
   ALERT,
   ALTERNATE_REDIRECT_TRUE,
+  BREAKOUTS,
   CALL,
   CONTROLS,
   DECLINE,
@@ -18,27 +19,69 @@ import {
   LEAVE,
   LOCI,
   LOCUS,
-  MEDIA,
   PARTICIPANT,
   PROVISIONAL_TYPE_DIAL_IN,
   PROVISIONAL_TYPE_DIAL_OUT,
+  REACHABILITY,
   SEND_DTMF_ENDPOINT,
-  _SLIDES_
+  _SLIDES_,
+  ANNOTATION,
 } from '../constants';
-import {Reaction} from '../reactions/reactions.type';
 import {SendReactionOptions, ToggleReactionsOptions} from './request.type';
+import MeetingUtil from './util';
 
 /**
  * @class MeetingRequest
  */
 export default class MeetingRequest extends StatelessWebexPlugin {
   changeVideoLayoutDebounced: any;
+  meetingRef: WeakRef<any>;
+  locusDeltaRequest: (options: object) => Promise<any>;
 
+  /**
+   * Constructor
+   * @param {Object} attrs
+   * @param {Object} options
+   */
   constructor(attrs: any, options: any) {
-    super(attrs, options);
-    this.changeVideoLayoutDebounced = debounce(this.changeVideoLayout, 2000, {leading: true, trailing: true});
+    const {meeting, ...otherAttrs} = attrs;
+
+    super(otherAttrs, options);
+
+    this.locusDeltaRequest = MeetingUtil.generateLocusDeltaRequest(meeting);
+
+    this.changeVideoLayoutDebounced = debounce(this.changeVideoLayout, 2000, {
+      leading: true,
+      trailing: true,
+    });
   }
 
+  /**
+   * Returns joinCookie from boundedStorage if present.
+   * @returns {Object} joinCookie
+   */
+  private getJoinCookie = async () => {
+    // @ts-ignore
+    const joinCookieRaw = await this.webex.boundedStorage
+      .get(REACHABILITY.namespace, REACHABILITY.localStorageJoinCookie)
+      .catch(() => {});
+
+    if (joinCookieRaw) {
+      try {
+        const joinCookie = JSON.parse(joinCookieRaw);
+        if (joinCookie) {
+          return joinCookie;
+        }
+      } catch (e) {
+        LoggerProxy.logger.error(
+          `MeetingRequest#constructor --> Error in parsing join cookie data: ${e}`
+        );
+      }
+    }
+
+    return null;
+  };
+
   /**
    * Make a network request to join a meeting
    * @param {Object} options
@@ -52,6 +95,10 @@ export default class MeetingRequest extends StatelessWebexPlugin {
    * @param {boolean} options.pin
    * @param {boolean} options.moveToResource
    * @param {Object} options.roapMessage
+   * @param {boolean} options.breakoutsSupported
+   * @param {String} options.locale,
+   * @param {Array} options.deviceCapabilities
+   * @param {boolean} options.liveAnnotationSupported
    * @returns {Promise}
    */
   async joinMeeting(options: {
@@ -70,6 +117,10 @@ export default class MeetingRequest extends StatelessWebexPlugin {
     meetingNumber: any;
     permissionToken: any;
     preferTranscoding: any;
+    breakoutsSupported: boolean;
+    locale?: string;
+    deviceCapabilities?: Array<string>;
+    liveAnnotationSupported: boolean;
   }) {
     const {
       asResourceOccupant,
@@ -85,35 +136,54 @@ export default class MeetingRequest extends StatelessWebexPlugin {
       pin,
       moveToResource,
       roapMessage,
-      preferTranscoding
+      preferTranscoding,
+      breakoutsSupported,
+      locale,
+      deviceCapabilities = [],
+      liveAnnotationSupported,
     } = options;
 
-    LoggerProxy.logger.info(
-      'Meeting:request#joinMeeting --> Joining a meeting',
-      correlationId
-    );
+    LoggerProxy.logger.info('Meeting:request#joinMeeting --> Joining a meeting', correlationId);
 
     let url = '';
 
+    const joinCookie = await this.getJoinCookie();
+
     const body: any = {
       asResourceOccupant,
       device: {
         url: deviceUrl,
         // @ts-ignore - config comes from registerPlugin
-        deviceType: this.config.meetings.deviceType
+        deviceType: this.config.meetings.deviceType,
       },
       usingResource: resourceId || null,
-      moveMediaToResource: resourceId && moveToResource || false,
+      moveMediaToResource: (resourceId && moveToResource) || false,
       correlationId,
       respOnlySdp: true,
       allowMultiDevice: true,
       ensureConversation: ensureConversation || false,
       supportsNativeLobby: 1,
       clientMediaPreferences: {
-        preferTranscoding: preferTranscoding ?? true
-      }
+        preferTranscoding: preferTranscoding ?? true,
+        joinCookie,
+      },
     };
 
+    if (breakoutsSupported) {
+      deviceCapabilities.push(BREAKOUTS.BREAKOUTS_SUPPORTED);
+    }
+    if (liveAnnotationSupported) {
+      deviceCapabilities.push(ANNOTATION.ANNOTATION_ON_SHARE_SUPPORTED);
+    }
+
+    if (locale) {
+      body.locale = locale;
+    }
+
+    // add deviceCapabilities prop
+    if (deviceCapabilities.length) {
+      body.deviceCapabilities = deviceCapabilities;
+    }
     // @ts-ignore
     if (this.webex.meetings.clientRegion) {
       // @ts-ignore
@@ -136,30 +206,29 @@ export default class MeetingRequest extends StatelessWebexPlugin {
 
     if (locusUrl) {
       url = `${locusUrl}/${PARTICIPANT}`;
-    }
-    else if (inviteeAddress || meetingNumber) {
+    } else if (inviteeAddress || meetingNumber) {
       try {
         // @ts-ignore
         await this.webex.internal.services.waitForCatalog('postauth');
         // @ts-ignore
         url = `${this.webex.internal.services.get('locus')}/${LOCI}/${CALL}`;
         body.invitee = {
-          address: inviteeAddress || `wbxmn:${meetingNumber}`
+          address: inviteeAddress || `wbxmn:${meetingNumber}`,
         };
-      }
-      catch (e) {
-        LoggerProxy.logger.error(`Meeting:request#joinMeeting Error Joining ${inviteeAddress || meetingNumber} --> ${e}`);
-        throw (e);
+      } catch (e) {
+        LoggerProxy.logger.error(
+          `Meeting:request#joinMeeting Error Joining ${inviteeAddress || meetingNumber} --> ${e}`
+        );
+        throw e;
       }
     }
 
-
     // TODO: -- this will be resolved in SDK request
     url = url.concat(`?${ALTERNATE_REDIRECT_TRUE}`);
 
     if (resourceId === inviteeAddress) {
       body.callPreferences = {
-        requestedMedia: [_SLIDES_]
+        requestedMedia: [_SLIDES_],
       };
     }
 
@@ -171,7 +240,7 @@ export default class MeetingRequest extends StatelessWebexPlugin {
     return this.request({
       method: HTTP_VERBS.POST,
       uri: url,
-      body
+      body,
     });
   }
 
@@ -183,16 +252,22 @@ export default class MeetingRequest extends StatelessWebexPlugin {
    * @returns {Promise}
    * @private
    */
-  private refreshCaptcha({ captchaRefreshUrl, captchaId }: { captchaRefreshUrl: string; captchaId: string }) {
+  private refreshCaptcha({
+    captchaRefreshUrl,
+    captchaId,
+  }: {
+    captchaRefreshUrl: string;
+    captchaId: string;
+  }) {
     const body = {
-      captchaId
+      captchaId,
     };
 
     // @ts-ignore
     return this.request({
       method: HTTP_VERBS.POST,
       uri: captchaRefreshUrl,
-      body
+      body,
     }).catch((err) => {
       LoggerProxy.logger.error(`Meeting:request#refreshCaptcha --> Error: ${err}`);
 
@@ -232,18 +307,20 @@ export default class MeetingRequest extends StatelessWebexPlugin {
         deviceType: deviceType.PROVISIONAL,
         provisionalType: PROVISIONAL_TYPE_DIAL_IN,
         url: dialInUrl,
-        clientUrl
+        clientUrl,
       },
-      correlationId
+      correlationId,
     };
 
     // @ts-ignore
-    return this.request({
+    return this.locusDeltaRequest({
       method: HTTP_VERBS.POST,
       uri,
-      body
+      body,
     }).catch((err) => {
-      LoggerProxy.logger.error(`Meeting:request#dialIn --> Error provisioning a dial in device, error ${err}`);
+      LoggerProxy.logger.error(
+        `Meeting:request#dialIn --> Error provisioning a dial in device, error ${err}`
+      );
 
       throw err;
     });
@@ -285,18 +362,20 @@ export default class MeetingRequest extends StatelessWebexPlugin {
         provisionalType: PROVISIONAL_TYPE_DIAL_OUT,
         url: dialOutUrl,
         dialoutAddress: phoneNumber,
-        clientUrl
+        clientUrl,
       },
-      correlationId
+      correlationId,
     };
 
     // @ts-ignore
-    return this.request({
+    return this.locusDeltaRequest({
       method: HTTP_VERBS.POST,
       uri,
-      body
+      body,
     }).catch((err) => {
-      LoggerProxy.logger.error(`Meeting:request#dialOut --> Error provisioning a dial out device, error ${err}`);
+      LoggerProxy.logger.error(
+        `Meeting:request#dialOut --> Error provisioning a dial out device, error ${err}`
+      );
 
       throw err;
     });
@@ -309,7 +388,7 @@ export default class MeetingRequest extends StatelessWebexPlugin {
    * @param {String} options.syncUrl sync url to get ht elatest locus delta
    * @returns {Promise}
    */
-  syncMeeting(options: { desync: boolean; syncUrl: string }) {
+  syncMeeting(options: {desync: boolean; syncUrl: string}) {
     /* eslint-disable no-else-return */
     const {desync} = options;
     let {syncUrl} = options;
@@ -317,16 +396,20 @@ export default class MeetingRequest extends StatelessWebexPlugin {
     /* istanbul ignore else */
     if (desync) {
       // check for existing URL parameters
-      syncUrl = syncUrl.concat(syncUrl.split('?')[1] ? '&' : '?').concat(`${LOCUS.SYNCDEBUG}=${desync}`);
+      syncUrl = syncUrl
+        .concat(syncUrl.split('?')[1] ? '&' : '?')
+        .concat(`${LOCUS.SYNCDEBUG}=${desync}`);
     }
 
     // @ts-ignore
     return this.request({
       method: HTTP_VERBS.GET,
-      uri: syncUrl
+      uri: syncUrl,
     }) // TODO: Handle if delta sync failed . Get the full locus object
       .catch((err) => {
-        LoggerProxy.logger.error(`Meeting:request#syncMeeting --> Error syncing meeting, error ${err}`);
+        LoggerProxy.logger.error(
+          `Meeting:request#syncMeeting --> Error syncing meeting, error ${err}`
+        );
 
         return err;
       });
@@ -339,7 +422,7 @@ export default class MeetingRequest extends StatelessWebexPlugin {
    * @param {String} options.locusUrl sync url to get ht elatest locus delta
    * @returns {Promise}
    */
-  getFullLocus(options: { desync: boolean; locusUrl: string }) {
+  getFullLocus(options: {desync: boolean; locusUrl: string}) {
     let {locusUrl} = options;
     const {desync} = options;
 
@@ -351,9 +434,11 @@ export default class MeetingRequest extends StatelessWebexPlugin {
       // @ts-ignore
       return this.request({
         method: HTTP_VERBS.GET,
-        uri: locusUrl
+        uri: locusUrl,
       }).catch((err) => {
-        LoggerProxy.logger.error(`Meeting:request#getFullLocus --> Error getting full locus, error ${err}`);
+        LoggerProxy.logger.error(
+          `Meeting:request#getFullLocus --> Error getting full locus, error ${err}`
+        );
 
         return err;
       });
@@ -392,16 +477,16 @@ export default class MeetingRequest extends StatelessWebexPlugin {
     const body = {
       device: {
         deviceType: deviceType.PROVISIONAL,
-        url: phoneUrl
+        url: phoneUrl,
       },
-      correlationId
+      correlationId,
     };
 
     // @ts-ignore
-    return this.request({
+    return this.locusDeltaRequest({
       method: HTTP_VERBS.PUT,
       uri,
-      body
+      body,
     }).catch((err) => {
       LoggerProxy.logger.error(
         `Meeting:request#disconnectPhoneAudio --> Error when requesting phone ${phoneUrl} to leave, error ${err}`
@@ -434,27 +519,23 @@ export default class MeetingRequest extends StatelessWebexPlugin {
     resourceId: string;
     correlationId: string;
   }) {
-    LoggerProxy.logger.info(
-      'Meeting:request#leaveMeeting --> Leaving a meeting',
-      correlationId
-    );
+    LoggerProxy.logger.info('Meeting:request#leaveMeeting --> Leaving a meeting', correlationId);
 
     const uri = `${locusUrl}/${PARTICIPANT}/${selfId}/${LEAVE}`;
     const body = {
       device: {
         // @ts-ignore
         deviceType: this.config.meetings.deviceType,
-        url
+        url,
       },
       usingResource: resourceId || null,
-      correlationId
+      correlationId,
     };
 
-    // @ts-ignore
-    return this.request({
+    return this.locusDeltaRequest({
       method: HTTP_VERBS.PUT,
       uri,
-      body
+      body,
     });
   }
 
@@ -466,63 +547,42 @@ export default class MeetingRequest extends StatelessWebexPlugin {
    * @param {String} options.correlationId
    * @returns {Promise}
    */
-  acknowledgeMeeting(options: { locusUrl: string; deviceUrl: string; correlationId: string }) {
+  acknowledgeMeeting(options: {locusUrl: string; deviceUrl: string; correlationId: string}) {
     const uri = `${options.locusUrl}/${PARTICIPANT}/${ALERT}`;
     const body = {
       device: {
         // @ts-ignore
         deviceType: this.config.meetings.deviceType,
-        url: options.deviceUrl
+        url: options.deviceUrl,
       },
-      correlationId: options.correlationId
+      correlationId: options.correlationId,
     };
 
-    // @ts-ignore
-    return this.request({
+    return this.locusDeltaRequest({
       method: HTTP_VERBS.PUT,
       uri,
-      body
+      body,
     });
   }
 
   /**
-   * Make a network request to acknowledge a meeting
+   * Makes a network request to lock the meeting
    * @param {Object} options
-   * @param {String} options.locusUrl
-   * @param {String} options.deviceUrl
-   * @param {String} options.id
+   * @param {Boolean} options.lock Whether it is locked or not
    * @returns {Promise}
    */
-  recordMeeting(options: { locusUrl: string; deviceUrl: string; id: string, recording: any, paused: any }) {
-    const uri = `${options.locusUrl}/${CONTROLS}`;
-    const body = {
-      record: {
-        recording: options.recording,
-        paused: options.paused
-      }
-    };
-
-    // @ts-ignore
-    return this.request({
-      method: HTTP_VERBS.PATCH,
-      uri,
-      body
-    });
-  }
-
   lockMeeting(options) {
     const uri = `${options.locusUrl}/${CONTROLS}`;
     const body = {
       lock: {
-        locked: options.lock
-      }
+        locked: options.lock,
+      },
     };
 
-    // @ts-ignore
-    return this.request({
+    return this.locusDeltaRequest({
       method: HTTP_VERBS.PATCH,
       uri,
-      body
+      body,
     });
   }
 
@@ -534,64 +594,21 @@ export default class MeetingRequest extends StatelessWebexPlugin {
    * @param {String} options.reason
    * @returns {Promise}
    */
-  declineMeeting(options: { locusUrl: string; deviceUrl: string; reason: string }) {
+  declineMeeting(options: {locusUrl: string; deviceUrl: string; reason: string}) {
     const uri = `${options.locusUrl}/${PARTICIPANT}/${DECLINE}`;
     const body = {
       device: {
         // @ts-ignore
         deviceType: this.config.meetings.deviceType,
-        url: options.deviceUrl
+        url: options.deviceUrl,
       },
       ...(options.reason && {reason: options.reason}),
     };
 
-    // @ts-ignore
-    return this.request({
-      method: HTTP_VERBS.PUT,
-      uri,
-      body
-    });
-  }
-
-  /**
-   * Toggle remote audio and/or video
-   * @param {Object} options options for toggling
-   * @param {String} options.selfId Locus self id??
-   * @param {String} options.locusUrl Locus url
-   * @param {String} options.deviceUrl Url of a device
-   * @param {String} options.resourceId Populated if you are paired to a device
-   * @param {String} options.localMedias local sdps
-   * @param {Boolean} options.preferTranscoding false for multistream (Homer), true for transcoded media (Edonus)
-   * @returns {Promise}
-   */
-  remoteAudioVideoToggle(options: {
-    selfId: string;
-    locusUrl: string;
-    deviceUrl: string;
-    resourceId: string;
-    localMedias: string;
-  } | any) {
-    const uri = `${options.locusUrl}/${PARTICIPANT}/${options.selfId}/${MEDIA}`;
-    const body = {
-      device: {
-        // @ts-ignore
-        deviceType: this.config.meetings.deviceType,
-        url: options.deviceUrl
-      },
-      usingResource: options.resourceId || null,
-      correlationId: options.correlationId,
-      respOnlySdp: true,
-      localMedias: options.localMedias,
-      clientMediaPreferences: {
-        preferTranscoding: options.preferTranscoding ?? true
-      }
-    };
-
-    // @ts-ignore
-    return this.request({
+    return this.locusDeltaRequest({
       method: HTTP_VERBS.PUT,
       uri,
-      body
+      body,
     });
   }
 
@@ -605,13 +622,18 @@ export default class MeetingRequest extends StatelessWebexPlugin {
    * @param {String} options.uri floor grant uri
    * @returns {Promise}
    */
-  changeMeetingFloor(options: {
-    disposition: string;
-    personUrl: string;
-    deviceUrl: string;
-    resourceId: string;
-    uri: string;
-  } | any) {
+  changeMeetingFloor(
+    options:
+      | {
+          disposition: string;
+          personUrl: string;
+          deviceUrl: string;
+          resourceId: string;
+          uri: string;
+          annotation: any;
+        }
+      | any
+  ) {
     let floorReq: any = {disposition: options.disposition};
 
     /* istanbul ignore else */
@@ -623,31 +645,34 @@ export default class MeetingRequest extends StatelessWebexPlugin {
             {
               // @ts-ignore
               deviceType: this.config.meetings.deviceType,
-              url: options.deviceUrl
-            }
-          ]
+              url: options.deviceUrl,
+            },
+          ],
         },
         disposition: options.disposition,
         requester: {
-          url: options.personUrl
-        }
+          url: options.personUrl,
+        },
       };
     }
 
     const body: any = {
       floor: floorReq,
-      resourceUrl: options.resourceUrl
+      resourceUrl: options.resourceUrl,
     };
 
     if (options?.resourceToken) {
       body.resourceToken = options?.resourceToken;
     }
+    if (options?.annotation) {
+      body.annotation = options?.annotation;
+    }
 
     // @ts-ignore
     return this.request({
       uri: options.uri,
       method: HTTP_VERBS.PUT,
-      body
+      body,
     });
   }
 
@@ -659,18 +684,18 @@ export default class MeetingRequest extends StatelessWebexPlugin {
    * @param {String} options.tones a string of one or more DTMF tones to send
    * @returns {Promise}
    */
-  sendDTMF({ locusUrl, deviceUrl, tones }: { locusUrl: string; deviceUrl: string; tones: string }) {
+  sendDTMF({locusUrl, deviceUrl, tones}: {locusUrl: string; deviceUrl: string; tones: string}) {
     // @ts-ignore
-    return this.request({
+    return this.locusDeltaRequest({
       method: HTTP_VERBS.POST,
       uri: `${locusUrl}/${SEND_DTMF_ENDPOINT}`,
       body: {
         deviceUrl,
         dtmf: {
           correlationId: uuid.v4(),
-          tones
-        }
-      }
+          tones,
+        },
+      },
     });
   }
 
@@ -709,36 +734,49 @@ export default class MeetingRequest extends StatelessWebexPlugin {
   }) {
     // send main/content renderInfo only if both width and height are specified
     if (main && (!main.width || !main.height)) {
-      return Promise.reject(new Error(`Both width and height must be specified. One of them is missing for main: ${JSON.stringify(main)}`));
+      return Promise.reject(
+        new Error(
+          `Both width and height must be specified. One of them is missing for main: ${JSON.stringify(
+            main
+          )}`
+        )
+      );
     }
 
     if (content && (!content.width || !content.height)) {
-      return Promise.reject(new Error(`Both width and height must be specified. One of them is missing for content: ${JSON.stringify(content)}`));
+      return Promise.reject(
+        new Error(
+          `Both width and height must be specified. One of them is missing for content: ${JSON.stringify(
+            content
+          )}`
+        )
+      );
     }
 
-    const renderInfoMain = (main) ? {width: main.width, height: main.height} : undefined;
-    const renderInfoContent = (content) ? {width: content.width, height: content.height} : undefined;
+    const renderInfoMain = main ? {width: main.width, height: main.height} : undefined;
+    const renderInfoContent = content ? {width: content.width, height: content.height} : undefined;
 
-    const layoutParams = (renderInfoMain || renderInfoContent) ?
-      {
-        renderInfo:
-        {
-          main: renderInfoMain,
-          content: renderInfoContent
-        }
-      } : undefined;
+    const layoutParams =
+      renderInfoMain || renderInfoContent
+        ? {
+            renderInfo: {
+              main: renderInfoMain,
+              content: renderInfoContent,
+            },
+          }
+        : undefined;
 
     // @ts-ignore
-    return this.request({
+    return this.locusDeltaRequest({
       method: HTTP_VERBS.PUT,
       uri: `${locusUrl}/${CONTROLS}`,
       body: {
         layout: {
           deviceUrl,
           type: layoutType,
-          layoutParams
-        }
-      }
+          layoutParams,
+        },
+      },
     });
   }
 
@@ -748,13 +786,13 @@ export default class MeetingRequest extends StatelessWebexPlugin {
    * @param {Url} options.locusUrl
    * @returns {Promise}
    */
-  endMeetingForAll({ locusUrl }: { locusUrl: string }) {
+  endMeetingForAll({locusUrl}: {locusUrl: string}) {
     const uri = `${locusUrl}/${END}`;
 
     // @ts-ignore
-    return this.request({
+    return this.locusDeltaRequest({
       method: HTTP_VERBS.POST,
-      uri
+      uri,
     });
   }
 
@@ -764,11 +802,11 @@ export default class MeetingRequest extends StatelessWebexPlugin {
    * @param {Url} options.keepAliveUrl
    * @returns {Promise}
    */
-  keepAlive({ keepAliveUrl }: { keepAliveUrl: string }) {
+  keepAlive({keepAliveUrl}: {keepAliveUrl: string}) {
     // @ts-ignore
     return this.request({
       method: HTTP_VERBS.GET,
-      uri: keepAliveUrl
+      uri: keepAliveUrl,
     });
   }
 
@@ -780,7 +818,7 @@ export default class MeetingRequest extends StatelessWebexPlugin {
    * @param {string} options.senderID
    * @returns {Promise}
    */
-  sendReaction({ reactionChannelUrl, reaction, participantId }: SendReactionOptions) {
+  sendReaction({reactionChannelUrl, reaction, participantId}: SendReactionOptions) {
     const uri = reactionChannelUrl;
 
     // @ts-ignore
@@ -790,7 +828,7 @@ export default class MeetingRequest extends StatelessWebexPlugin {
       body: {
         sender: {participantId},
         reaction,
-      }
+      },
     });
   }
 
@@ -800,18 +838,27 @@ export default class MeetingRequest extends StatelessWebexPlugin {
    * @param {locusUrl} options.locusUrl
    * @returns {Promise}
    */
-  toggleReactions({ enable, locusUrl, requestingParticipantId }: ToggleReactionsOptions) {
+  toggleReactions({enable, locusUrl, requestingParticipantId}: ToggleReactionsOptions) {
     const uri = `${locusUrl}/${CONTROLS}`;
 
-    return this.request({
+    // @ts-ignore
+    return this.locusDeltaRequest({
       method: HTTP_VERBS.PUT,
       uri,
       body: {
         reactions: {
-          enabled: enable
+          enabled: enable,
         },
         requestingParticipantId,
-      }
+      },
+    });
+  }
+
+  getLocusStatusByUrl(locusUrl: string) {
+    // @ts-ignore
+    return this.request({
+      method: HTTP_VERBS.GET,
+      uri: locusUrl,
     });
   }
 }