@webex/plugin-meetings 3.8.1-web-workers-keepalive.1 → 3.9.0-webinar5k.1

package/src/meeting/index.ts

@@ -66,7 +66,7 @@ import Media, {type BundlePolicy} from '../media';
 import MediaProperties from '../media/properties';
 import MeetingStateMachine from './state';
 import {createMuteState} from './muteState';
-import LocusInfo from '../locus-info';
+import LocusInfo, {LocusDTO, LocusLLMEvent} from '../locus-info';
 import Metrics from '../metrics';
 import ReconnectionManager from '../reconnection-manager';
 import ReconnectionNotStartedError from '../common/errors/reconnection-not-started';
@@ -121,6 +121,7 @@ import {
   WEBINAR_ERROR_REGISTRATION_ID,
   JOIN_BEFORE_HOST,
   REGISTRATION_ID_STATUS,
+  STAGE_MANAGER_TYPE,
 } from '../constants';
 import BEHAVIORAL_METRICS from '../metrics/constants';
 import ParameterError from '../common/errors/parameter';
@@ -164,6 +165,8 @@ import {BrbState, createBrbState} from './brbState';
 import MultistreamNotSupportedError from '../common/errors/multistream-not-supported-error';
 import JoinForbiddenError from '../common/errors/join-forbidden-error';
 import {ReachabilityMetrics} from '../reachability/reachability.types';
+import {SetStageOptions, SetStageVideoLayout, UnsetStageVideoLayout} from './request.type';
+import {DataSet} from '../hashTree/hashTreeParser';
 
 // default callback so we don't call an undefined function, but in practice it should never be used
 const DEFAULT_ICE_PHASE_CALLBACK = () => 'JOIN_MEETING_FINAL';
@@ -3861,15 +3864,16 @@ export default class Meeting extends StatelessWebexPlugin {
   }
 
   /**
-   * Cancel an SIP call invitation made during a meeting
+   * Cancel an SIP/phone call invitation made during a meeting
    * @param {Object} invitee
    * @param {String} invitee.memberId
-   * @returns {Promise} see #members.cancelSIPInvite
+   * @param {Boolean} [invitee.isInternalNumber] - When cancel phone invitation, if the number is internal
+   * @returns {Promise} see #members.cancelInviteByMemberId
    * @public
    * @memberof Meeting
    */
-  public cancelSIPInvite(invitee: {memberId: string}) {
-    return this.members.cancelSIPInvite(invitee);
+  public cancelInviteByMemberId(invitee: {memberId: string; isInternalNumber?: boolean}) {
+    return this.members.cancelInviteByMemberId(invitee);
   }
 
   /**
@@ -4475,11 +4479,13 @@ export default class Meeting extends StatelessWebexPlugin {
   setLocus(
     locus:
       | {
+          locus: LocusDTO;
           mediaConnections: Array<any>;
           locusUrl: string;
           locusId: string;
           mediaId: string;
           host: object;
+          dataSets: DataSet[];
         }
       | any
   ) {
@@ -4493,7 +4499,7 @@ export default class Meeting extends StatelessWebexPlugin {
     this.selfId = locus.selfId;
     this.mediaId = locus.mediaId;
     this.hostId = mtgLocus.host ? mtgLocus.host.id : this.hostId;
-    this.locusInfo.initialSetup(mtgLocus);
+    this.locusInfo.initialSetup(mtgLocus, locus.dataSets);
   }
 
   /**
@@ -5606,6 +5612,21 @@ export default class Meeting extends StatelessWebexPlugin {
     }
   }
 
+  /** Handles Locus LLM events
+   *
+   * @param {LocusLLMEvent} event - The Locus LLM event to process
+   * @returns {void}
+   */
+  private processLocusLLMEvent = (event: LocusLLMEvent): void => {
+    if (event.data.eventType === 'locus.state_message') {
+      this.locusInfo.parse(this, event.data);
+    } else {
+      LoggerProxy.logger.warn(
+        `Meeting:index#processLocusLLMEvent --> Unknown event type: ${event.data.eventType}`
+      );
+    }
+  };
+
   /**
    * Callback called when a relay event is received from meeting LLM Connection
    * @param {RelayEvent} e Event object coming from LLM Connection
@@ -6026,6 +6047,8 @@ export default class Meeting extends StatelessWebexPlugin {
       );
       // @ts-ignore - Fix type
       this.webex.internal.llm.off('event:relay.event', this.processRelayEvent);
+      // @ts-ignore - Fix type
+      this.webex.internal.llm.off('event:locus.state_message', this.processLocusLLMEvent);
     }
 
     if (!isJoined) {
@@ -6040,6 +6063,10 @@ export default class Meeting extends StatelessWebexPlugin {
         this.webex.internal.llm.off('event:relay.event', this.processRelayEvent);
         // @ts-ignore - Fix type
         this.webex.internal.llm.on('event:relay.event', this.processRelayEvent);
+        // @ts-ignore - Fix type
+        this.webex.internal.llm.off('event:locus.state_message', this.processLocusLLMEvent);
+        // @ts-ignore - Fix type
+        this.webex.internal.llm.on('event:locus.state_message', this.processLocusLLMEvent);
         LoggerProxy.logger.info(
           'Meeting:index#updateLLMConnection --> enabled to receive relay events!'
         );
@@ -9211,6 +9238,8 @@ export default class Meeting extends StatelessWebexPlugin {
 
     // @ts-ignore - fix types
     this.webex.internal.llm.off('event:relay.event', this.processRelayEvent);
+    // @ts-ignore - Fix type
+    this.webex.internal.llm.off('event:locus.state_message', this.processLocusLLMEvent);
   };
 
   /**
@@ -9763,4 +9792,73 @@ export default class Meeting extends StatelessWebexPlugin {
       selected_subnet: selectedSubnetFirstOctet ? `${selectedSubnetFirstOctet}.X.X.X` : null,
     };
   }
+
+  /**
+   * Set the stage for the meeting
+   *
+   * @param {SetStageOptions} options Options to use when setting the stage
+   * @returns {Promise} The locus request
+   */
+  setStage({
+    activeSpeakerProportion = 0.5,
+    customBackground,
+    customLogo,
+    customNameLabel,
+    importantParticipants,
+    lockAttendeeViewOnStage = false,
+    showActiveSpeaker = false,
+  }: SetStageOptions = {}) {
+    const videoLayout: SetStageVideoLayout = {
+      overrideDefault: true,
+      lockAttendeeViewOnStageOnly: lockAttendeeViewOnStage,
+      stageParameters: {
+        activeSpeakerProportion,
+        showActiveSpeaker: {show: showActiveSpeaker, order: 0},
+        stageManagerType: 0,
+      },
+    };
+
+    if (importantParticipants?.length) {
+      videoLayout.stageParameters.importantParticipants = importantParticipants.map(
+        (importantParticipant, index) => ({...importantParticipant, order: index + 1})
+      );
+    }
+
+    if (customLogo) {
+      if (!videoLayout.customLayouts) {
+        videoLayout.customLayouts = {};
+      }
+      videoLayout.customLayouts.logo = customLogo;
+      // eslint-disable-next-line no-bitwise
+      videoLayout.stageParameters.stageManagerType |= STAGE_MANAGER_TYPE.LOGO;
+    }
+
+    if (customBackground) {
+      if (!videoLayout.customLayouts) {
+        videoLayout.customLayouts = {};
+      }
+      videoLayout.customLayouts.background = customBackground;
+      // eslint-disable-next-line no-bitwise
+      videoLayout.stageParameters.stageManagerType |= STAGE_MANAGER_TYPE.BACKGROUND;
+    }
+
+    if (customNameLabel) {
+      videoLayout.nameLabelStyle = customNameLabel;
+      // eslint-disable-next-line no-bitwise
+      videoLayout.stageParameters.stageManagerType |= STAGE_MANAGER_TYPE.NAME_LABEL;
+    }
+
+    return this.meetingRequest.synchronizeStage(this.locusUrl, videoLayout);
+  }
+
+  /**
+   * Unset the stage for the meeting
+   *
+   * @returns {Promise} The locus request
+   */
+  unsetStage() {
+    const videoLayout: UnsetStageVideoLayout = {overrideDefault: false};
+
+    return this.meetingRequest.synchronizeStage(this.locusUrl, videoLayout);
+  }
 }

package/src/meeting/muteState.ts

@@ -291,18 +291,14 @@ export class MuteState {
     );
 
     return MeetingUtil.remoteUpdateAudioVideo(meeting, audioMuted, videoMuted)
-      .then((locus) => {
+      .then((response) => {
         LoggerProxy.logger.info(
           `Meeting:muteState#sendLocalMuteRequestToServer --> ${this.type}: local mute (audio=${audioMuted}, video=${videoMuted}) applied to server`
         );
 
         this.state.server.localMute = this.type === AUDIO ? audioMuted : videoMuted;
 
-        if (locus) {
-          meeting.locusInfo.handleLocusDelta(locus, meeting);
-        }
-
-        return locus;
+        return MeetingUtil.updateLocusFromApiResponse(meeting, response);
       })
       .catch((remoteUpdateError) => {
         LoggerProxy.logger.warn(

package/src/meeting/request.ts

@@ -32,6 +32,7 @@ import {
   BrbOptions,
   ToggleReactionsOptions,
   PostMeetingDataConsentOptions,
+  SynchronizeVideoLayout,
 } from './request.type';
 import MeetingUtil from './util';
 import {AnnotationInfo} from '../annotation/annotation.types';
@@ -969,4 +970,19 @@ export default class MeetingRequest extends StatelessWebexPlugin {
       },
     });
   }
+
+  /**
+   * Synchronize the stage for a meeting
+   *
+   * @param {LocusUrl} locusUrl The locus URL
+   * @param {SetStageVideoLayout} videoLayout The video layout to synchronize
+   * @returns {Promise} The locus request
+   */
+  synchronizeStage(locusUrl: string, videoLayout: SynchronizeVideoLayout) {
+    return this.locusDeltaRequest({
+      method: HTTP_VERBS.PATCH,
+      uri: `${locusUrl}/${CONTROLS}`,
+      body: {videoLayout},
+    });
+  }
 }

package/src/meeting/request.type.ts

@@ -25,3 +25,67 @@ export type PostMeetingDataConsentOptions = {
   deviceUrl: string;
   selfId: string;
 };
+
+export type StageCustomLogoPositions =
+  | 'LowerLeft'
+  | 'LowerMiddle'
+  | 'LowerRight'
+  | 'UpperLeft'
+  | 'UpperMiddle'
+  | 'UpperRight';
+
+export type StageNameLabelType = 'Primary' | 'PrimaryInverted' | 'Secondary' | 'SecondaryInverted';
+
+export type StageCustomBackground = {
+  url: string;
+  [others: string]: unknown;
+};
+
+export type StageCustomLogo = {
+  url: string;
+  position: StageCustomLogoPositions;
+  [others: string]: unknown;
+};
+
+export type StageCustomNameLabel = {
+  accentColor: string;
+  background: {color: string};
+  border: {color: string};
+  content: {displayName: {color: string}; subtitle: {color: string}};
+  decoration: {color: string};
+  fadeOut?: {delay: number};
+  type: StageNameLabelType;
+  [others: string]: unknown;
+};
+
+export type SetStageOptions = {
+  activeSpeakerProportion?: number;
+  customBackground?: StageCustomBackground;
+  customLogo?: StageCustomLogo;
+  customNameLabel?: StageCustomNameLabel;
+  importantParticipants?: {mainCsi: number; participantId: string}[];
+  lockAttendeeViewOnStage?: boolean;
+  showActiveSpeaker?: boolean;
+};
+
+export type SetStageVideoLayout = {
+  overrideDefault: true;
+  lockAttendeeViewOnStageOnly: boolean;
+  stageParameters: {
+    importantParticipants?: {participantId: string; mainCsi: number; order: number}[];
+    showActiveSpeaker: {show: boolean; order: number};
+    activeSpeakerProportion: number;
+    stageManagerType: number;
+  };
+  customLayouts?: {
+    background?: StageCustomBackground;
+    logo?: StageCustomLogo;
+  };
+  nameLabelStyle?: StageCustomNameLabel;
+};
+
+export type UnsetStageVideoLayout = {
+  overrideDefault: false;
+};
+
+export type SynchronizeVideoLayout = SetStageVideoLayout | UnsetStageVideoLayout;

package/src/meeting/util.ts

@@ -31,6 +31,7 @@ const MeetingUtil = {
 
     // First todo: add check for existance
     parsed.locus = response.body.locus;
+    parsed.dataSets = response.body.dataSets;
     parsed.mediaConnections = response.body.mediaConnections;
     parsed.locusUrl = parsed.locus.url;
     parsed.locusId = parsed.locus.url.split('/').pop();
@@ -59,18 +60,16 @@ const MeetingUtil = {
       );
     }
 
-    return meeting.locusMediaRequest
-      .send({
-        type: 'LocalMute',
-        selfUrl: meeting.selfUrl,
-        mediaId: meeting.mediaId,
-        sequence: meeting.locusInfo.sequence,
-        muteOptions: {
-          audioMuted,
-          videoMuted,
-        },
-      })
-      .then((response) => response?.body?.locus);
+    return meeting.locusMediaRequest.send({
+      type: 'LocalMute',
+      selfUrl: meeting.selfUrl,
+      mediaId: meeting.mediaId,
+      sequence: meeting.locusInfo.sequence,
+      muteOptions: {
+        audioMuted,
+        videoMuted,
+      },
+    });
   },
 
   hasOwner: (info) => info && info.owner,
@@ -602,22 +601,20 @@ const MeetingUtil = {
   },
 
   /**
-   * Updates the locus info for the meeting with the delta locus
-   * returned from requests that include the sequence information
+   * Updates the locus info for the meeting with the locus
+   * information returned from API requests made to Locus
    * Returns the original response object
    * @param {Object} meeting The meeting object
    * @param {Object} response The response of the http request
    * @returns {Object}
    */
-  updateLocusWithDelta: (meeting, response) => {
+  updateLocusFromApiResponse: (meeting, response) => {
     if (!meeting) {
       return response;
     }
 
-    const locus = response?.body?.locus;
-
-    if (locus) {
-      meeting.locusInfo.handleLocusDelta(locus, meeting);
+    if (response?.body?.locus) {
+      meeting.locusInfo.handleLocusAPIResponse(meeting, response.body);
     }
 
     return response;
@@ -664,7 +661,7 @@ const MeetingUtil = {
 
       return meeting
         .request(options)
-        .then((response) => MeetingUtil.updateLocusWithDelta(meeting, response));
+        .then((response) => MeetingUtil.updateLocusFromApiResponse(meeting, response));
     };
 
     return locusDeltaRequest;

package/src/meetings/index.ts

@@ -66,6 +66,7 @@ import JoinWebinarError from '../common/errors/join-webinar-error';
 import {SpaceIDDeprecatedError} from '../common/errors/webex-errors';
 import NoMeetingInfoError from '../common/errors/no-meeting-info';
 import JoinForbiddenError from '../common/errors/join-forbidden-error';
+import {DataSet} from '../hashTree/hashTreeParser';
 
 let mediaLogger;
 
@@ -407,6 +408,13 @@ export default class Meetings extends WebexPlugin {
    * @memberof Meetings
    */
   getCorrespondingMeetingByLocus(data) {
+    if (data.eventType === 'locus.state_message' && data.stateElementsMessage?.locusUrl) {
+      return this.meetingCollection.getByKey(
+        MEETING_KEY.LOCUS_URL,
+        data.stateElementsMessage.locusUrl
+      );
+    }
+
     // getting meeting by correlationId. This will happen for the new event
     // Either the locus
     // TODO : Add check for the callBack Address
@@ -445,7 +453,10 @@ export default class Meetings extends WebexPlugin {
    * @private
    * @memberof Meetings
    */
-  private handleLocusEvent(data: {locusUrl: string; locus: any}, useRandomDelayForInfo = false) {
+  private handleLocusEvent(
+    data: {locusUrl: string; locus: any; dataSets?: DataSet[]},
+    useRandomDelayForInfo = false
+  ) {
     let meeting = this.getCorrespondingMeetingByLocus(data);
 
     // Special case when locus has got replaced, This only happend once if a replace locus exists
@@ -524,7 +535,7 @@ export default class Meetings extends WebexPlugin {
           meeting = newMeeting;
 
           // It's a new meeting so initialize the locus data
-          meeting.locusInfo.initialSetup(data.locus);
+          meeting.locusInfo.initialSetup(data.locus, data.dataSets);
           this.checkHandleBreakoutLocus(data.locus);
         })
         .catch((e) => {
@@ -1824,7 +1835,10 @@ export default class Meetings extends WebexPlugin {
     }
 
     const associateBreakoutLocus = this.breakoutLocusForHandleLater[existIndex];
-    this.handleLocusEvent({locus: associateBreakoutLocus, locusUrl: associateBreakoutLocus.url});
+    this.handleLocusEvent({
+      locus: associateBreakoutLocus,
+      locusUrl: associateBreakoutLocus.url,
+    });
     this.breakoutLocusForHandleLater.splice(existIndex, 1);
   }
 

package/src/member/index.ts

@@ -3,6 +3,7 @@
  */
 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;

package/src/member/types.ts

@@ -109,4 +109,5 @@ export interface Participant {
   status: ParticipantMediaStatus;
   type: string;
   url: ParticipantUrl;
+  isRemoved: boolean; // JS-SDK internal field to indicate in updates when the participant is removed
 }

package/src/members/collection.ts

@@ -39,6 +39,17 @@ export default class MembersCollection {
     return this.members;
   }
 
+  /**
+   * Removes a member from the collection
+   * @param {String} id
+   * @returns {void}
+   */
+  remove(id: string) {
+    if (this.members[id]) {
+      delete this.members[id];
+    }
+  }
+
   /**
    * @returns {void}
    * reset members

package/src/members/index.ts

@@ -73,7 +73,11 @@ import {ServerRoleShape} from './types';
  * @memberof Members
  */
 
-type UpdatedMembers = {added: Array<Member>; updated: Array<Member>};
+type UpdatedMembers = {
+  added: Array<Member>;
+  updated: Array<Member>;
+  removedIds?: Array<string>; // removed member ids
+};
 /**
  * @class Members
  */
@@ -388,7 +392,11 @@ export default class Members extends StatelessWebexPlugin {
    * @private
    * @memberof Members
    */
-  locusParticipantsUpdate(payload: {participants: object; isReplace?: boolean}) {
+  locusParticipantsUpdate(payload: {
+    participants: object;
+    isReplace?: boolean;
+    removedParticipantIds?: Array<string>;
+  }) {
     if (payload) {
       if (payload.isReplace) {
         this.clearMembers();
@@ -546,10 +554,22 @@ export default class Members extends StatelessWebexPlugin {
   private handleMembersUpdate(membersUpdate: UpdatedMembers) {
     this.constructMembers(membersUpdate.updated, true);
     this.constructMembers(membersUpdate.added, false);
+    this.removeMembers(membersUpdate.removedIds);
 
     return this.membersCollection.getAll();
   }
 
+  /**
+   * removes members from the collection
+   * @param {Array<string>} removedMembers removed members ids
+   * @returns {void}
+   */
+  private removeMembers(removedMembers: Array<string>) {
+    removedMembers.forEach((memberId) => {
+      this.membersCollection.remove(memberId);
+    });
+  }
+
   /**
    * set members to the member collection from each updated/added lists as passed in
    * @param {Array} list
@@ -599,6 +619,10 @@ export default class Members extends StatelessWebexPlugin {
     }
     const memberUpdate = this.update(payload.participants);
 
+    // this code depends on memberIds being the same as participantIds
+    // if MemberUtil.extractId() ever changes, this will need to be updated
+    memberUpdate.removedIds = payload.removedParticipantIds || [];
+
     return memberUpdate;
   }
 
@@ -846,12 +870,14 @@ export default class Members extends StatelessWebexPlugin {
   }
 
   /**
-   * Cancels an SIP call to the associated meeting
-   * @param {String} invitee
+   * Cancels an SIP/phone call to the associated meeting
+   * @param {Object} invitee
+   * @param {String} invitee.memberId - The memberId of the invitee
+   * @param {Boolean} [invitee.isInternalNumber] - When cancel phone invitation, if the number is internal
    * @returns {Promise}
    * @memberof Members
    */
-  cancelSIPInvite(invitee: any) {
+  cancelInviteByMemberId(invitee: {memberId: string; isInternalNumber?: boolean}) {
     if (!this.locusUrl) {
       return Promise.reject(
         new ParameterError('The associated locus url for this meeting object must be defined.')
@@ -862,9 +888,9 @@ export default class Members extends StatelessWebexPlugin {
         new ParameterError('The invitee must be defined with a memberId property.')
       );
     }
-    const options = MembersUtil.cancelSIPInviteOptions(invitee, this.locusUrl);
+    const options = MembersUtil.cancelInviteByMemberIdOptions(invitee, this.locusUrl);
 
-    return this.membersRequest.cancelSIPInvite(options);
+    return this.membersRequest.cancelInviteByMemberId(options);
   }
 
   /**

package/src/members/request.ts

@@ -285,14 +285,14 @@ export default class MembersRequest extends StatelessWebexPlugin {
    * @throws {Error} if the options are not valid and complete, must have invitee with memberId AND locusUrl
    * @memberof MembersRequest
    */
-  cancelSIPInvite(options: any) {
+  cancelInviteByMemberId(options: any) {
     if (!options?.invitee?.memberId || !options?.locusUrl) {
       throw new ParameterError(
         'invitee must be passed and the associated locus url for this meeting object must be defined.'
       );
     }
 
-    const requestParams = MembersUtil.generateCancelSIPInviteRequestParams(options);
+    const requestParams = MembersUtil.generateCancelInviteByMemberIdRequestParams(options);
 
     return this.locusDeltaRequest(requestParams);
   }

package/src/members/util.ts

@@ -1,4 +1,5 @@
 import uuid from 'uuid';
+import {has} from 'lodash';
 import {
   HTTP_VERBS,
   CONTROLS,
@@ -47,6 +48,9 @@ const MembersUtil = {
         address:
           options.invitee.emailAddress || options.invitee.email || options.invitee.phoneNumber,
         ...(options.invitee.roles ? {roles: options.invitee.roles} : {}),
+        ...(has(options.invitee, 'isInternalNumber')
+          ? {isInternalNumber: options.invitee.isInternalNumber}
+          : {}),
       },
     ],
     alertIfActive: options.alertIfActive,
@@ -107,6 +111,10 @@ const MembersUtil = {
     }
 
     if (invitee.phoneNumber) {
+      if (invitee.isInternalNumber) {
+        return !DIALER_REGEX.INTERNAL_NUMBER.test(invitee.phoneNumber);
+      }
+
       return !DIALER_REGEX.E164_FORMAT.test(invitee.phoneNumber);
     }
 
@@ -371,17 +379,20 @@ const MembersUtil = {
     return requestParams;
   },
 
-  cancelSIPInviteOptions: (invitee, locusUrl) => ({
+  cancelInviteByMemberIdOptions: (invitee, locusUrl) => ({
     invitee,
     locusUrl,
   }),
 
-  generateCancelSIPInviteRequestParams: (options) => {
+  generateCancelInviteByMemberIdRequestParams: (options) => {
+    const {memberId, isInternalNumber} = options.invitee;
+    const hasIsInternalNumberProp = has(options.invitee, 'isInternalNumber');
     const body = {
       actionType: _REMOVE_,
       invitees: [
         {
-          address: options.invitee.memberId,
+          address: memberId,
+          ...(hasIsInternalNumberProp ? {isInternalNumber} : {}),
         },
       ],
     };