@webex/plugin-meetings 3.8.1 → 3.9.0-multipleLLM.1

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,42 @@ 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},
+    });
+  }
+
+  /**
+   * Sends a request to notify the host of a meeting.
+   * @param {string} siteFullUrl - The site URL.
+   * @param {string} locusId - The locus ID.
+   * @param {string} meetingUuid - The meeting UUID.
+   * @param {Array<string>} displayName - The display names to notify the host about.
+   * @returns {Promise}
+   */
+  notifyHost(siteFullUrl: string, locusId: string, meetingUuid: string, displayName: string[]) {
+    // @ts-ignore
+    return this.request({
+      method: HTTP_VERBS.POST,
+      uri: `https://${siteFullUrl}/wbxappapi/v1/meetings/${meetingUuid}/notifyhost`,
+      body: {
+        displayName,
+        size: displayName?.length,
+      },
+      headers: {
+        locusId,
+      },
+    });
+  }
 }

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/type.ts

@@ -0,0 +1,9 @@
+export type Invitee = {
+  memberId: string;
+  emailAddress: string;
+  email: string;
+  phoneNumber: string;
+  roles: Array<string>;
+  skipEmailValidation?: boolean;
+  isInternalNumber?: boolean;
+};

package/src/meeting/util.ts

@@ -59,18 +59,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,
@@ -115,6 +113,28 @@ const MeetingUtil = {
     return IP_VERSION.unknown;
   },
 
+  /**
+   * Returns CA event labels related to Orpheus ipver parameter that can be sent to CA with any CA event
+   * @param {any} webex instance
+   * @returns {Array<string>|undefined} array of CA event labels or undefined if no labels should be sent
+   */
+  getCaEventLabelsForIpVersion(webex: any): Array<string> | undefined {
+    const ipver = MeetingUtil.getIpVersion(webex);
+
+    switch (ipver) {
+      case IP_VERSION.unknown:
+        return undefined;
+      case IP_VERSION.only_ipv4:
+        return ['hasIpv4_true'];
+      case IP_VERSION.only_ipv6:
+        return ['hasIpv6_true'];
+      case IP_VERSION.ipv4_and_ipv6:
+        return ['hasIpv4_true', 'hasIpv6_true'];
+      default:
+        return undefined;
+    }
+  },
+
   joinMeeting: async (meeting, options) => {
     if (!meeting) {
       return Promise.reject(new ParameterError('You need a meeting object.'));
@@ -197,6 +217,17 @@ const MeetingUtil = {
         });
 
         return parsed;
+      })
+      .catch((err) => {
+        webex.internal.newMetrics.submitClientEvent({
+          name: 'client.locus.join.response',
+          payload: {
+            identifiers: {meetingLookupUrl: meeting.meetingInfo?.meetingLookupUrl},
+          },
+          options: {meetingId: meeting.id, rawError: err},
+        });
+
+        throw err;
       });
   },
 
@@ -208,6 +239,10 @@ const MeetingUtil = {
     meeting.simultaneousInterpretation.cleanUp();
     meeting.locusMediaRequest = undefined;
 
+    meeting.webex?.internal?.newMetrics?.callDiagnosticMetrics?.clearEventLimitsForCorrelationId(
+      meeting.correlationId
+    );
+
     // make sure we send last metrics before we close the peerconnection
     const stopStatsAnalyzer = meeting.statsAnalyzer
       ? meeting.statsAnalyzer.stopAnalyzer()
@@ -328,10 +363,57 @@ const MeetingUtil = {
     meeting.resourceId = meeting.resourceId || options.resourceId;
 
     if (meeting.requiredCaptcha) {
-      return Promise.reject(new CaptchaError());
+      const errorToThrow = new CaptchaError();
+
+      // @ts-ignore
+      webex.internal.newMetrics.submitClientEvent({
+        name: 'client.meetinginfo.response',
+        options: {
+          meetingId: meeting.id,
+        },
+        payload: {
+          errors: [
+            {
+              fatal: false,
+              category: 'expected',
+              name: 'other',
+              shownToUser: false,
+              errorCode: errorToThrow.code,
+              errorDescription: errorToThrow.name,
+              rawErrorMessage: errorToThrow.sdkMessage,
+            },
+          ],
+        },
+      });
+
+      return Promise.reject(errorToThrow);
     }
+
     if (meeting.passwordStatus === PASSWORD_STATUS.REQUIRED) {
-      return Promise.reject(new PasswordError());
+      const errorToThrow = new PasswordError();
+
+      // @ts-ignore
+      webex.internal.newMetrics.submitClientEvent({
+        name: 'client.meetinginfo.response',
+        options: {
+          meetingId: meeting.id,
+        },
+        payload: {
+          errors: [
+            {
+              fatal: false,
+              category: 'expected',
+              name: 'other',
+              shownToUser: false,
+              errorCode: errorToThrow.code,
+              errorDescription: errorToThrow.name,
+              rawErrorMessage: errorToThrow.sdkMessage,
+            },
+          ],
+        },
+      });
+
+      return Promise.reject(errorToThrow);
     }
 
     if (options.pin) {
@@ -542,11 +624,23 @@ const MeetingUtil = {
   canStartManualCaption: (displayHints) =>
     displayHints.includes(DISPLAY_HINTS.MANUAL_CAPTION_START),
 
+  isLocalRecordingStarted: (displayHints) =>
+    displayHints.includes(DISPLAY_HINTS.LOCAL_RECORDING_STATUS_STARTED),
+
+  isLocalRecordingStopped: (displayHints) =>
+    displayHints.includes(DISPLAY_HINTS.LOCAL_RECORDING_STATUS_STOPPED),
+
+  isLocalRecordingPaused: (displayHints) =>
+    displayHints.includes(DISPLAY_HINTS.LOCAL_RECORDING_STATUS_PAUSED),
+
   canStopManualCaption: (displayHints) => displayHints.includes(DISPLAY_HINTS.MANUAL_CAPTION_STOP),
 
   isManualCaptionActive: (displayHints) =>
     displayHints.includes(DISPLAY_HINTS.MANUAL_CAPTION_STATUS_ACTIVE),
 
+  isSpokenLanguageAutoDetectionEnabled: (displayHints) =>
+    displayHints.includes(DISPLAY_HINTS.SPOKEN_LANGUAGE_AUTO_DETECTION_ENABLED),
+
   isWebexAssistantActive: (displayHints) =>
     displayHints.includes(DISPLAY_HINTS.WEBEX_ASSISTANT_STATUS_ACTIVE),
 
@@ -602,22 +696,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 +756,7 @@ const MeetingUtil = {
 
       return meeting
         .request(options)
-        .then((response) => MeetingUtil.updateLocusWithDelta(meeting, response));
+        .then((response) => MeetingUtil.updateLocusFromApiResponse(meeting, response));
     };
 
     return locusDeltaRequest;

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

@@ -371,6 +371,7 @@ export default class MeetingInfoV2 {
    * @param {String} conversationUrl conversationUrl to start adhoc meeting on
    * @param {String} installedOrgID org ID of user's machine
    * @param {Boolean} enableStaticMeetingLink whether or not to enable static meeting link
+   * @param {String} classificationId need it to start adhoc meeting if space support classification
    * @returns {Promise} returns a meeting info object
    * @public
    * @memberof MeetingInfo
@@ -379,7 +380,8 @@ export default class MeetingInfoV2 {
     conversationUrl: string,
     installedOrgID?: string,
     // setting this to true enables static meeting link
-    enableStaticMeetingLink = false
+    enableStaticMeetingLink = false,
+    classificationId = undefined
   ) {
     const getInvitees = (particpants = []) => {
       const invitees = [];
@@ -407,6 +409,7 @@ export default class MeetingInfoV2 {
           invitees: getInvitees(conversation.participants?.items),
           installedOrgID,
           schedule: enableStaticMeetingLink,
+          classificationId,
         };
 
         if (installedOrgID) {
@@ -429,16 +432,26 @@ export default class MeetingInfoV2 {
    * Creates adhoc space meetings for a space by fetching the conversation infomation
    * @param {String} conversationUrl conversationUrl to start adhoc meeting on
    * @param {String} installedOrgID org ID of user's machine
+   * @param {String} classificationId if space is support classification, it needs provide it during start instant meeting
    * @returns {Promise} returns a meeting info object
    * @public
    * @memberof MeetingInfo
    */
-  async createAdhocSpaceMeeting(conversationUrl: string, installedOrgID?: string) {
+  async createAdhocSpaceMeeting(
+    conversationUrl: string,
+    installedOrgID?: string,
+    classificationId?: string
+  ) {
     if (!this.webex.meetings.preferredWebexSite) {
       throw Error('No preferred webex site found');
     }
 
-    return this.createAdhocSpaceMeetingOrEnableStaticMeetingLink(conversationUrl, installedOrgID)
+    return this.createAdhocSpaceMeetingOrEnableStaticMeetingLink(
+      conversationUrl,
+      installedOrgID,
+      false,
+      classificationId
+    )
       .then((requestResult) => {
         Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.ADHOC_MEETING_SUCCESS);
 
@@ -618,6 +631,7 @@ export default class MeetingInfoV2 {
    * @param {Object} options
    * @param {String} registrationId
    * @param {String} fullSiteUrl
+   * @param {String} classificationId
    * @returns {Promise} returns a meeting info object
    * @public
    * @memberof MeetingInfo
@@ -635,7 +649,8 @@ export default class MeetingInfoV2 {
     extraParams: object = {},
     options: {meetingId?: string; sendCAevents?: boolean} = {},
     registrationId: string = null,
-    fullSiteUrl: string = null
+    fullSiteUrl: string = null,
+    classificationId: string = null
   ) {
     const {meetingId, sendCAevents} = options;
 
@@ -650,7 +665,11 @@ export default class MeetingInfoV2 {
       this.webex.config.meetings.experimental.enableAdhocMeetings &&
       this.webex.meetings.preferredWebexSite
     ) {
-      return this.createAdhocSpaceMeeting(destinationType.destination, installedOrgID);
+      return this.createAdhocSpaceMeeting(
+        destinationType.destination,
+        installedOrgID,
+        classificationId
+      );
     }
 
     const body = await MeetingInfoUtil.getRequestBody({

package/src/meetings/index.ts

@@ -1331,6 +1331,7 @@ export default class Meetings extends WebexPlugin {
    * @param {Object} [meetingInfo] - Pre-fetched complete meeting info
    * @param {String} [meetingLookupUrl] - meeting info prefetch url
    * @param {string} sessionCorrelationId - the optional specified sessionCorrelationId (callStateForMetrics.sessionCorrelationId) can be provided instead
+   * @param {String} classificationId - If space support classification, it will provide it while start instant meeting
    * @returns {Promise<Meeting>} A new Meeting.
    * @public
    * @memberof Meetings
@@ -1345,7 +1346,8 @@ export default class Meetings extends WebexPlugin {
     callStateForMetrics: CallStateForMetrics = undefined,
     meetingInfo = undefined,
     meetingLookupUrl = undefined,
-    sessionCorrelationId: string = undefined
+    sessionCorrelationId: string = undefined,
+    classificationId: string = undefined
   ) {
     // Validate meeting information based on the provided destination and
     // type. This must be performed prior to determining if the meeting is
@@ -1415,7 +1417,8 @@ export default class Meetings extends WebexPlugin {
               callStateForMetrics,
               failOnMissingMeetingInfo,
               meetingInfo,
-              meetingLookupUrl
+              meetingLookupUrl,
+              classificationId
             ).then((createdMeeting: any) => {
               // If the meeting was successfully created.
               if (createdMeeting && createdMeeting.on) {
@@ -1529,6 +1532,7 @@ export default class Meetings extends WebexPlugin {
    * @param {Boolean} failOnMissingMeetingInfo - whether to throw an error if meeting info fails to fetch (for calls that are not 1:1 or content share)
    * @param {Object} [meetingInfo] - Pre-fetched complete meeting info
    * @param {String} [meetingLookupUrl] - meeting info prefetch url
+   * @param {String} classificationId see create()
    * @returns {Promise} a new meeting instance complete with meeting info and destination
    * @private
    * @memberof Meetings
@@ -1541,7 +1545,8 @@ export default class Meetings extends WebexPlugin {
     callStateForMetrics: CallStateForMetrics = undefined,
     failOnMissingMeetingInfo = false,
     meetingInfo = undefined,
-    meetingLookupUrl = undefined
+    meetingLookupUrl = undefined,
+    classificationId = undefined
   ) {
     const meeting = new Meeting(
       {
@@ -1560,11 +1565,12 @@ export default class Meetings extends WebexPlugin {
       {
         // @ts-ignore
         parent: this.webex,
+      },
+      (newMeeting) => {
+        this.meetingCollection.set(newMeeting);
       }
     );
 
-    this.meetingCollection.set(meeting);
-
     try {
       // if no participant has joined the scheduled meeting (meaning meeting is not active) and we get a locusEvent,
       // it means the meeting will start in 5-6 min. In that case, we want to fetchMeetingInfo
@@ -1588,6 +1594,7 @@ export default class Meetings extends WebexPlugin {
       // @ts-ignore
       const {enableUnifiedMeetings} = this.config.experimental;
       const meetingInfoOptions = {
+        classificationId,
         extraParams: infoExtraParams,
         sendCAevents: !!callStateForMetrics?.correlationId, // if client sends correlation id as argument of public create(), then it means that this meeting creation is part of a pre-join intent from user
       };

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