@webex/plugin-meetings 3.8.0-web-workers-keepalive.1 → 3.8.1-next.1

package/src/meeting/locusMediaRequest.ts

@@ -221,14 +221,6 @@ export class LocusMediaRequest extends WebexPlugin {
         localMedias.roapMessage = request.roapMessage;
         localMedias.reachability = request.reachability;
         body.clientMediaPreferences = request.clientMediaPreferences;
-
-        // @ts-ignore
-        this.webex.internal.newMetrics.submitClientEvent({
-          name: 'client.locus.media.request',
-          options: {
-            meetingId: this.config.meetingId,
-          },
-        });
         break;
     }
 
@@ -269,16 +261,6 @@ export class LocusMediaRequest extends WebexPlugin {
           this.confluenceState = 'created';
         }
 
-        if (request.type === 'RoapMessage') {
-          // @ts-ignore
-          this.webex.internal.newMetrics.submitClientEvent({
-            name: 'client.locus.media.response',
-            options: {
-              meetingId: this.config.meetingId,
-            },
-          });
-        }
-
         return result;
       })
       .catch((e) => {

package/src/meeting/muteState.ts

@@ -119,9 +119,11 @@ export class MuteState {
    * @returns {void}
    */
   public enable(meeting: any, enable: boolean) {
-    this.state.client.enabled = enable;
+    if (enable !== this.state.client.enabled) {
+      this.state.client.enabled = enable;
 
-    this.applyClientStateToServer(meeting);
+      this.applyClientStateToServer(meeting);
+    }
   }
 
   /**
@@ -147,7 +149,6 @@ export class MuteState {
    * @public
    * @memberof MuteState
    * @param {Object} [meeting] the meeting object
-   * @param {Boolean} [mute] true for muting, false for unmuting request
    * @returns {void}
    */
   public handleLocalStreamMuteStateChange(meeting?: any) {
@@ -350,7 +351,6 @@ export class MuteState {
    * @param {Meeting} meeting
    * @returns {void}
    */
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
   private applyUnmuteAllowedToStream(meeting: any) {
     if (this.type === AUDIO) {
       meeting.mediaProperties.audioStream?.setUnmuteAllowed(this.state.server.unmuteAllowed);

package/src/meeting/request.ts

@@ -27,7 +27,12 @@ import {
   _SLIDES_,
   ANNOTATION,
 } from '../constants';
-import {SendReactionOptions, BrbOptions, ToggleReactionsOptions} from './request.type';
+import {
+  SendReactionOptions,
+  BrbOptions,
+  ToggleReactionsOptions,
+  PostMeetingDataConsentOptions,
+} from './request.type';
 import MeetingUtil from './util';
 import {AnnotationInfo} from '../annotation/annotation.types';
 import {ClientMediaPreferences} from '../reachability/reachability.types';
@@ -934,4 +939,34 @@ export default class MeetingRequest extends StatelessWebexPlugin {
       },
     });
   }
+
+  /**
+   * Sends a request to set post meeting data consent.
+   *
+   * @param {Object} options - The options for post meeting data consent request.
+   * @param {boolean} options.consent - Whether accepted or declined.
+   * @param {string} options.locusUrl - The URL of the locus.
+   * @param {string} options.deviceUrl - The URL of the device.
+   * @param {string} options.selfId - The ID of the participant.
+   * @returns {Promise}
+   */
+  setPostMeetingDataConsent({
+    postMeetingDataConsent,
+    locusUrl,
+    deviceUrl,
+    selfId,
+  }: PostMeetingDataConsentOptions) {
+    const uri = `${locusUrl}/${PARTICIPANT}/${selfId}/${CONTROLS}`;
+
+    return this.locusDeltaRequest({
+      method: HTTP_VERBS.PATCH,
+      uri,
+      body: {
+        consent: {
+          postMeetingDataConsent,
+          deviceUrl,
+        },
+      },
+    });
+  }
 }

package/src/meeting/request.type.ts

@@ -18,3 +18,10 @@ export type BrbOptions = {
   deviceUrl: string;
   selfId: string;
 };
+
+export type PostMeetingDataConsentOptions = {
+  postMeetingDataConsent: boolean;
+  locusUrl: string;
+  deviceUrl: string;
+  selfId: string;
+};

package/src/meeting/util.ts

@@ -573,9 +573,17 @@ const MeetingUtil = {
   canUserRenameSelfAndObserved: (displayHints) =>
     displayHints.includes(DISPLAY_HINTS.CAN_RENAME_SELF_AND_OBSERVED),
 
+  requiresPostMeetingDataConsentPrompt: (displayHints) =>
+    displayHints.includes(DISPLAY_HINTS.SHOW_POST_MEETING_DATA_CONSENT_PROMPT),
+
   canUserRenameOthers: (displayHints) => displayHints.includes(DISPLAY_HINTS.CAN_RENAME_OTHERS),
 
-  canShareWhiteBoard: (displayHints) => displayHints.includes(DISPLAY_HINTS.SHARE_WHITEBOARD),
+  // Default empty value for policies if we get an undefined value (ie permissionToken is not available)
+  canShareWhiteBoard: (displayHints, policies = {}) =>
+    displayHints.includes(DISPLAY_HINTS.SHARE_WHITEBOARD) &&
+    !!policies[SELF_POLICY.SUPPORT_WHITEBOARD],
+
+  canMoveToLobby: (displayHints) => displayHints.includes(DISPLAY_HINTS.MOVE_TO_LOBBY),
 
   /**
    * Adds the current locus sequence information to a request body

package/src/meeting-info/meeting-info-v2.ts

@@ -617,6 +617,7 @@ export default class MeetingInfoV2 {
    * @param {Object} extraParams
    * @param {Object} options
    * @param {String} registrationId
+   * @param {String} fullSiteUrl
    * @returns {Promise} returns a meeting info object
    * @public
    * @memberof MeetingInfo
@@ -633,7 +634,8 @@ export default class MeetingInfoV2 {
     locusId = null,
     extraParams: object = {},
     options: {meetingId?: string; sendCAevents?: boolean} = {},
-    registrationId: string = null
+    registrationId: string = null,
+    fullSiteUrl: string = null
   ) {
     const {meetingId, sendCAevents} = options;
 
@@ -659,6 +661,7 @@ export default class MeetingInfoV2 {
       locusId,
       extraParams,
       registrationId,
+      disableWebRedirect: true,
     });
 
     // If the body only contains the default properties, we don't have enough to
@@ -684,7 +687,9 @@ export default class MeetingInfoV2 {
 
     const directURI = await MeetingInfoUtil.getDirectMeetingInfoURI(destinationType);
 
-    if (directURI) {
+    if (fullSiteUrl) {
+      requestOptions.uri = `https://${fullSiteUrl}/wbxappapi/v1/meetingInfo`;
+    } else if (directURI) {
       requestOptions.uri = directURI;
     } else {
       requestOptions.service = WBXAPPAPI_SERVICE;

package/src/meeting-info/utilv2.ts

@@ -237,6 +237,7 @@ export default class MeetingInfoUtil {
       locusId,
       extraParams,
       registrationId,
+      disableWebRedirect,
     } = options;
     const body: any = {
       ...DEFAULT_MEETING_INFO_REQUEST_BODY,
@@ -296,6 +297,10 @@ export default class MeetingInfoUtil {
       body.locusId = locusId;
     }
 
+    if (disableWebRedirect) {
+      body.disableWebRedirect = disableWebRedirect;
+    }
+
     return body;
   }
 

package/src/meetings/index.ts

@@ -807,6 +807,67 @@ export default class Meetings extends WebexPlugin {
     }
   }
 
+  /**
+   * API to toggle usage of audio main DTX, needs to be called before webex.meetings.register()
+   *
+   * @param {Boolean} newValue
+   * @private
+   * @memberof Meetings
+   * @returns {undefined}
+   */
+  private _toggleDisableAudioMainDtx(newValue: boolean) {
+    if (typeof newValue !== 'boolean') {
+      return;
+    }
+
+    // @ts-ignore
+    if (this.config.experimental.disableAudioMainDtx !== newValue) {
+      // @ts-ignore
+      this.config.experimental.disableAudioMainDtx = newValue;
+    }
+  }
+
+  /**
+   * API to toggle usage of audio twcc support
+   *
+   * @param {Boolean} newValue
+   * @private
+   * @memberof Meetings
+   * @returns {undefined}
+   */
+  private _toggleEnableAudioTwccForMultistream(newValue: boolean) {
+    if (typeof newValue !== 'boolean') {
+      return;
+    }
+
+    // @ts-ignore
+    if (this.config.enableAudioTwccForMultistream !== newValue) {
+      // @ts-ignore
+      this.config.enableAudioTwccForMultistream = newValue;
+    }
+  }
+
+  /**
+   * API to toggle stopping ICE Candidates Gathering after first relay candidate,
+   * needs to be called before webex.meetings.joinWithMedia()
+   *
+   * @param {Boolean} newValue
+   * @private
+   * @memberof Meetings
+   * @returns {undefined}
+   */
+  private _toggleStopIceGatheringAfterFirstRelayCandidate(newValue: boolean) {
+    if (typeof newValue !== 'boolean') {
+      return;
+    }
+
+    // @ts-ignore
+    if (this.config.stopIceGatheringAfterFirstRelayCandidate !== newValue) {
+      // @ts-ignore
+      this.config.stopIceGatheringAfterFirstRelayCandidate = newValue;
+    }
+  }
+
   /**
    * Executes a registration step and updates the registration status.
    * @param {Function} step - The registration step to execute.
@@ -935,6 +996,21 @@ export default class Meetings extends WebexPlugin {
         .disconnect()
         // @ts-ignore
         .then(() => this.webex.internal.device.unregister())
+        .catch((error) => {
+          // If error status code is 404, continue the chain
+          if (error.statusCode === 404) {
+            LoggerProxy.logger.info(
+              'Meetings:index#unregister --> 404 error during device unregister, proceeding normally'
+            );
+
+            return; // returning undefined allows the chain to continue
+          }
+          // For any other status code, break the chain by rethrowing
+          LoggerProxy.logger.error(
+            `Meetings:index#unregister --> Failed to unregister device: ${error.message}`
+          );
+          throw error; // rethrow to break the promise chain
+        })
         .then(() => {
           Trigger.trigger(
             this,

package/src/meetings/util.ts

@@ -99,6 +99,24 @@ MeetingsUtil.getMediaServer = (sdp) => {
   return mediaServer;
 };
 
+MeetingsUtil.getMediaServerIp = (sdp) => {
+  let mediaServerIp;
+
+  // Attempt to collect the media server from the roap message.
+  try {
+    mediaServerIp = sdp
+      .split('\r\n')
+      .find((line) => line.startsWith('o='))
+      .match(/o=\S+ \d+ \d+ IN IP4 ([\d.]+)/)?.[1]
+      .toLowerCase()
+      .trim();
+  } catch {
+    mediaServerIp = undefined;
+  }
+
+  return mediaServerIp;
+};
+
 MeetingsUtil.checkForCorrelationId = (deviceUrl, locus) => {
   let devices = [];
 

package/src/member/index.ts

@@ -1,18 +1,20 @@
 /*!
  * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
  */
-import {MEETINGS, _IN_LOBBY_, _NOT_IN_MEETING_, _IN_MEETING_} from '../constants';
-import {IExternalRoles, IMediaStatus, ParticipantWithRoles} from './types';
+import {MEETINGS, _IN_LOBBY_, _NOT_IN_MEETING_, _IN_MEETING_, _OBSERVE_} from '../constants';
+import {IExternalRoles, IMediaStatus, Participant, ParticipantUrl} from './types';
 
 import MemberUtil from './util';
 
+export type MemberId = string;
 /**
  * @class Member
  */
 export default class Member {
-  associatedUser: any;
+  associatedUser: MemberId | null; // deprecated, use associatedUsers instead
+  associatedUsers: Set<MemberId>; // users associated with this device, empty if this member is not a device
   canReclaimHost: boolean;
-  id: any;
+  id: MemberId;
   isAudioMuted: any;
   isContentSharing: any;
   isDevice: any;
@@ -29,6 +31,7 @@ export default class Member {
   isRecording: any;
   isRemovable: any;
   isSelf: any;
+  isPairedWithSelf: boolean; // true for a device that we are paired with
   isBrb: boolean;
   isUser: any;
   isVideoMuted: any;
@@ -42,6 +45,10 @@ export default class Member {
   supportLiveAnnotation: boolean;
   type: any;
   namespace = MEETINGS;
+  pairedWith: {
+    participantUrl?: ParticipantUrl;
+    memberId?: MemberId;
+  };
 
   /**
    * @param {Object} participant - the locus participant
@@ -54,7 +61,7 @@ export default class Member {
    * @memberof Member
    */
   constructor(
-    participant: object,
+    participant: Participant,
     options:
       | {
           selfId: string;
@@ -201,13 +208,23 @@ export default class Member {
      */
     this.isUser = null;
     /**
+     * Deprecated: use associatedUsers instead
      * Is this member associated to another user by way of pairing (typical of devices)
      * @instance
-     * @type {String}
+     * @type {MemberId|null}
+     * @deprecated
      * @public
      * @memberof Member
      */
     this.associatedUser = null;
+    /**
+     * Is this member associated to another user by way of pairing (typical of devices)
+     * @instance
+     * @type {String}
+     * @public
+     * @memberof Member
+     */
+    this.associatedUsers = new Set<MemberId>();
     /**
      * @instance
      * @type {Boolean}
@@ -266,6 +283,14 @@ export default class Member {
      */
     this.isPresenterAssignmentProhibited = null;
 
+    /**
+     * @instance
+     * @type {Boolean}
+     * @public
+     * @memberof Member
+     */
+    this.isPairedWithSelf = false;
+
     /**
      * @instance
      * @type {IExternalRoles}
@@ -274,6 +299,10 @@ export default class Member {
      */
     this.roles = null;
 
+    this.pairedWith = {
+      participantUrl: undefined,
+      memberId: undefined,
+    };
     /**
      * @instance
      * @type {IMediaStatus}
@@ -299,9 +328,10 @@ export default class Member {
    * @private
    * @memberof Member
    */
-  private processParticipant(participant: object) {
+  private processParticipant(participant: Participant) {
     this.participant = participant;
     if (participant) {
+      this.processPairedDevice(participant);
       this.canReclaimHost = MemberUtil.canReclaimHost(participant);
       this.id = MemberUtil.extractId(participant);
       this.name = MemberUtil.extractName(participant);
@@ -321,12 +351,24 @@ export default class Member {
       this.isPresenterAssignmentProhibited =
         MemberUtil.isPresenterAssignmentProhibited(participant);
       this.processStatus(participant);
-      this.processRoles(participant as ParticipantWithRoles);
+      this.processRoles(participant);
       // must be done last
       this.isNotAdmitted = MemberUtil.isNotAdmitted(participant, this.isGuest, this.status);
     }
   }
 
+  /**
+   * Checks if the participant is paired with another device
+   *
+   * @param {any} participant the locus participant object
+   * @returns {void}
+   */
+  processPairedDevice(participant: Participant) {
+    // we can't populate this.pairedWith.memberId here because the member for that device might not yet exist
+    // so only populating the participantUrl and memberId will be set later
+    this.pairedWith.participantUrl = MemberUtil.extractPairedWithParticipantUrl(participant);
+  }
+
   /**
    * Use the members options and participant values to set on the member
    * @param {Object} participant the locus participant object
@@ -335,7 +377,7 @@ export default class Member {
    * @private
    * @memberof Member
    */
-  private processParticipantOptions(participant: object, options: any) {
+  private processParticipantOptions(participant: Participant, options: any) {
     if (participant && options) {
       this.processIsSelf(participant, options.selfId);
       this.processIsHost(participant, options.hostId);
@@ -378,7 +420,7 @@ export default class Member {
    * @private
    * @memberof Member
    */
-  private processStatus(participant: object) {
+  private processStatus(participant: Participant) {
     this.status = MemberUtil.extractStatus(participant);
     switch (this.status) {
       case _IN_LOBBY_:
@@ -440,11 +482,9 @@ export default class Member {
    * @public
    * @memberof Member
    */
-  public processIsContentSharing(participant: object, sharingId: string) {
+  public processIsContentSharing(participant: Participant, sharingId: string) {
     if (MemberUtil.isUser(participant)) {
       this.isContentSharing = MemberUtil.isSame(participant, sharingId);
-    } else if (MemberUtil.isDevice(participant)) {
-      this.isContentSharing = MemberUtil.isAssociatedSame(participant, sharingId);
     }
   }
 
@@ -456,7 +496,7 @@ export default class Member {
    * @public
    * @memberof Member
    */
-  public processIsRecording(participant: object, recordingId: string) {
+  public processIsRecording(participant: Participant, recordingId: string) {
     this.isRecording = MemberUtil.isSame(participant, recordingId);
   }
 
@@ -468,12 +508,9 @@ export default class Member {
    * @private
    * @memberof Member
    */
-  private processIsSelf(participant: object, selfId: string) {
+  private processIsSelf(participant: Participant, selfId: string) {
     if (MemberUtil.isUser(participant)) {
       this.isSelf = MemberUtil.isSame(participant, selfId);
-    } else if (MemberUtil.isDevice(participant)) {
-      this.isSelf = MemberUtil.isAssociatedSame(participant, selfId);
-      this.associatedUser = selfId;
     }
   }
 
@@ -485,11 +522,9 @@ export default class Member {
    * @private
    * @memberof Member
    */
-  private processIsHost(participant: object, hostId: string) {
+  private processIsHost(participant: Participant, hostId: string) {
     if (MemberUtil.isUser(participant)) {
       this.isHost = MemberUtil.isSame(participant, hostId);
-    } else if (MemberUtil.isDevice(participant)) {
-      this.isHost = MemberUtil.isAssociatedSame(participant, hostId);
     }
   }
 
@@ -500,7 +535,7 @@ export default class Member {
    * @private
    * @memberof Member
    */
-  private processRoles(participant: ParticipantWithRoles) {
+  private processRoles(participant: Participant) {
     this.roles = MemberUtil.extractControlRoles(participant);
   }
 

package/src/member/types.ts

@@ -15,22 +15,6 @@ export type ServerRoleShape = {
   hasRole: boolean;
 };
 
-export type ParticipantWithRoles = {
-  controls: {
-    role: {
-      roles: Array<ServerRoleShape>;
-    };
-  };
-};
-
-export type ParticipantWithBrb = {
-  controls: {
-    brb?: {
-      enabled: boolean;
-    };
-  };
-};
-
 // values are inherited from locus so don't update these
 export enum MediaStatus {
   RECVONLY = 'RECVONLY', // participant only receiving and not sending
@@ -44,3 +28,85 @@ export interface IMediaStatus {
   audio: MediaStatus;
   video: MediaStatus;
 }
+
+export type Csi = number;
+export type Direction = 'inactive' | 'sendrecv' | 'sendonly' | 'recvonly';
+export type ParticipantUrl = string;
+export interface MediaSession {
+  csi: Csi;
+  direction: Direction;
+  mediaContent: 'main' | 'slides';
+  mediaType: 'audio' | 'video';
+  state: string;
+}
+
+export interface Intent {
+  associatedWith: ParticipantUrl;
+  id: string;
+  type: string; // could be "WAIT" or "OBSERVE" or other....
+}
+export interface ParticipantDevice {
+  correlationId: string;
+  csis: Csi[];
+  deviceType: string; // WDM device type, could be "WEB", "TP_ENDPOINT", "MAC" or other things, don't know the full list, so keeping it as string
+  intent?: Intent;
+  intents: Array<Intent | null>;
+  isVideoCallback: boolean;
+  mediaSessions: Array<MediaSession>;
+  mediaSessionsExternal: boolean;
+  state: string; // probably one of MEETING_STATE.STATES
+}
+
+// this is not a complete type, Locus may send more fields
+export interface ParticipantPerson {
+  id: string;
+  isExternal: boolean;
+  name: string;
+  orgId: string;
+}
+
+export interface ParticipantMediaStatus {
+  audioStatus: MediaStatus;
+  videoStatus: MediaStatus;
+  audioSlidesStatus?: MediaStatus;
+  videoSlidesStatus?: MediaStatus;
+  csis: Csi[];
+}
+
+// this is not a complete type, Locus may send more fields
+export interface ParticipantControls {
+  role: {
+    roles: Array<ServerRoleShape>;
+  };
+  brb?: {
+    enabled: boolean;
+  };
+  hand: {
+    raised: boolean;
+  };
+  localRecord: {
+    recording: boolean;
+  };
+}
+
+// this is not a complete type, Locus may send more fields
+export interface Participant {
+  canBeController: boolean;
+  controls: ParticipantControls;
+  deviceUrl: string;
+  devices: Array<ParticipantDevice>;
+  guest: boolean;
+  id: string;
+  identity: string;
+  identityTrustLevel: string; // could be 'INTERNAL', 'EXTERNAL' or other....
+  isCreator: boolean;
+  moderator: boolean; // Locus docs say this is deprecated and role control should be used instead
+  moderatorAssignmentNotAllowed: boolean;
+  presenterAssignmentNotAllowed: boolean;
+  person: ParticipantPerson;
+  resourceGuest: boolean;
+  state: string; // probably one of MEETING_STATE.STATES
+  status: ParticipantMediaStatus;
+  type: string;
+  url: ParticipantUrl;
+}