@webex/plugin-meetings 3.12.0-next.5 → 3.12.0-next.50

package/src/meetings/index.ts

@@ -55,10 +55,12 @@ import PasswordError from '../common/errors/password-error';
 import CaptchaError from '../common/errors/captcha-error';
 import MeetingCollection from './collection';
 import {
+  FetchSitePreferencesMeViaSiteOptions,
   MEETING_KEY,
   INoiseReductionEffect,
   IVirtualBackgroundEffect,
   MeetingRegistrationStatus,
+  SitePreferencesResponse,
 } from './meetings.types';
 import MeetingsUtil from './util';
 import PermissionError from '../common/errors/permission';
@@ -69,7 +71,9 @@ import JoinForbiddenError from '../common/errors/join-forbidden-error';
 import {HashTreeMessage} from '../hashTree/hashTreeParser';
 import {HashTreeObject} from '../hashTree/types';
 import {isSelf} from '../hashTree/utils';
+
 import {createLocusFromHashTreeMessage, findMeetingForHashTreeMessage} from '../locus-info';
+import {LocusDTO} from '../locus-info/types';
 
 let mediaLogger;
 
@@ -313,7 +317,7 @@ export default class Meetings extends WebexPlugin {
     const breakoutLocus = this.meetingCollection.getActiveBreakoutLocus(breakoutUrl);
 
     const isSelfJoined = newLocus?.self?.state === _JOINED_;
-    const isSelfMoved = newLocus?.self?.state === _LEFT_ && newLocus?.self?.reason === _MOVED_;
+    const isSelfMoved = MeetingsUtil.isSelfMovedOrBreakoutEnded(newLocus);
     // @ts-ignore
     const deviceFromNewLocus = MeetingsUtil.getThisDevice(newLocus, this.webex.internal.device.url);
     const isResourceMovedOnThisDevice =
@@ -390,7 +394,7 @@ export default class Meetings extends WebexPlugin {
   private isNeedHandleLocusDTO(meeting: any, newLocus: any) {
     if (newLocus) {
       const isNewLocusAsBreakout = MeetingsUtil.isBreakoutLocusDTO(newLocus);
-      const isSelfMoved = newLocus?.self?.state === _LEFT_ && newLocus?.self?.reason === _MOVED_;
+      const isSelfMoved = MeetingsUtil.isSelfMovedOrBreakoutEnded(newLocus);
       const isSelfMovedToLobby =
         newLocus?.self?.devices[0]?.intent?.reason === _ON_HOLD_LOBBY_ &&
         newLocus?.self?.devices[0]?.intent?.type === _WAIT_;
@@ -435,14 +439,11 @@ export default class Meetings extends WebexPlugin {
     if (existingMeeting) {
       return existingMeeting;
     }
-
     if (data.eventType === LOCUSEVENT.HASH_TREE_DATA_UPDATED) {
       // need to check if maybe this event indicates a move to/from breakout
       const meetingForHashTreeMessage = findMeetingForHashTreeMessage(
-        data.stateElementsMessage,
-        this.meetingCollection,
-        // @ts-ignore
-        this.webex.internal.device.url
+        data?.stateElementsMessage,
+        this.meetingCollection
       );
 
       if (meetingForHashTreeMessage) {
@@ -492,7 +493,6 @@ export default class Meetings extends WebexPlugin {
    */
   private handleLocusEvent(data: LocusEvent, useRandomDelayForInfo = false) {
     let meeting = this.getCorrespondingMeetingByLocus(data);
-
     // @ts-ignore
     if (this.config.experimental.storeLocusHashTreeEventsForDebugging) {
       storeEventForDebugging('mercury', data);
@@ -586,17 +586,21 @@ export default class Meetings extends WebexPlugin {
       this.create(data.locus, DESTINATION_TYPE.LOCUS_ID, useRandomDelayForInfo)
         .then(async (newMeeting) => {
           meeting = newMeeting;
-
           try {
             // It's a new meeting so initialize the locus data
-            await meeting.locusInfo.initialSetup({
-              trigger:
-                data.eventType === LOCUSEVENT.SDK_LOCUS_FROM_SYNC_MEETINGS
-                  ? 'get-loci-response'
-                  : 'locus-message',
-              locus: data.locus,
-              hashTreeMessage: data.stateElementsMessage,
-            });
+            await meeting.locusInfo.initialSetup(
+              {
+                trigger:
+                  data.eventType === LOCUSEVENT.SDK_LOCUS_FROM_SYNC_MEETINGS
+                    ? 'get-loci-response'
+                    : 'locus-message',
+                locus: data.locus,
+                hashTreeMessage: data.stateElementsMessage,
+              },
+              (locus: LocusDTO) => {
+                meeting.finalizeMeetingAfterInitialLocusSetup(locus);
+              }
+            );
           } catch (error) {
             LoggerProxy.logger.warn(
               `Meetings:index#handleLocusEvent --> Error initializing locus data: ${error.message}`
@@ -1403,6 +1407,31 @@ export default class Meetings extends WebexPlugin {
     return this.personalMeetingRoom;
   }
 
+  /**
+   * Fetches site preferences for the provided Webex site, or the preferred Webex site.
+   * This is used to determine capabilities of the site, such as whether scheduling a webinar is supported.
+   *
+   * @param {object} [options]
+   * @param {string} [options.siteUrl] - Webex site URL. Defaults to preferredWebexSite, for example "cisco.webex.com".
+   * @param {string} [options.siteName] - Site name query override. Defaults to the site name derived from siteUrl, for example "cisco" for "cisco.webex.com".
+   * @param {SitePreferenceSelectOption[]} [options.selectOptions] - Preference sections to fetch. Defaults to 'scheduling'.
+   * @returns {Promise<SitePreferencesResponse>} site preferences response body
+   * @throws {ParameterError}
+   * @public
+   * @memberof Meetings
+   * @example
+   * const preferences = await webex.meetings.fetchSitePreferencesMeViaSite();
+   * const supportScheduleWebinar = preferences?.scheduling?.supportScheduleWebinar;
+   */
+  public fetchSitePreferencesMeViaSite(
+    options: FetchSitePreferencesMeViaSiteOptions = {}
+  ): Promise<SitePreferencesResponse> {
+    return this.request.fetchSitePreferencesMeViaSite({
+      ...options,
+      siteUrl: options.siteUrl || this.preferredWebexSite,
+    });
+  }
+
   /**
    * Returns basic information about a meeting that exists or
    * used to exist in the MeetingCollection
@@ -1765,6 +1794,7 @@ export default class Meetings extends WebexPlugin {
         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
       };
+      const shouldDeferMeetingInfoFetch = type === DESTINATION_TYPE.LOCUS_ID && !destination?.info;
 
       if (meetingInfo) {
         meeting.injectMeetingInfo(meetingInfo, meetingInfoOptions, meetingLookupUrl);
@@ -1776,8 +1806,12 @@ export default class Meetings extends WebexPlugin {
             waitingTime
           );
           meeting.parseMeetingInfo(undefined, destination);
-        } else {
+        } else if (!shouldDeferMeetingInfoFetch) {
           await meeting.fetchMeetingInfo(meetingInfoOptions);
+        } else {
+          LoggerProxy.logger.info(
+            'Meetings:index#createMeeting --> defer fetchMeetingInfo for incomplete locus, will do it after locus initialSetup'
+          );
         }
       }
     } catch (err) {
@@ -1811,7 +1845,11 @@ export default class Meetings extends WebexPlugin {
       // For type LOCUS_ID we need to parse the locus object to get the information
       // about the caller and callee
       // Meeting Added event will be created in `handleLocusEvent`
-      if (type !== DESTINATION_TYPE.LOCUS_ID) {
+      // Only emit MEETING_ADDED if the meeting still exists in the collection.
+      // If fetchMeetingInfo failed and the meeting was destroyed in the catch block,
+      // skip emitting to prevent orphaned meeting references on the consumer side.
+      // @ts-ignore - getMeetingByType types value as object but accepts strings (same as handleLocusEvent)
+      if (type !== DESTINATION_TYPE.LOCUS_ID && this.getMeetingByType(_ID_, meeting.id)) {
         if (!meeting.sipUri) {
           meeting.setSipUri(destination);
         }
@@ -1886,23 +1924,20 @@ export default class Meetings extends WebexPlugin {
    * @public
    * @memberof Meetings
    */
-  public syncMeetings({keepOnlyLocusMeetings = true} = {}): Promise<void> {
+  public async syncMeetings({keepOnlyLocusMeetings = true} = {}): Promise<void> {
     // @ts-ignore
     if (this.webex.credentials.isUnverifiedGuest) {
       LoggerProxy.logger.info(
-        'Meetings:index#syncMeetings --> skipping meeting sync as unverified guest'
+        'Meetings:index#syncMeetings --> user is unverified guest, skipping calling Locus for meeting sync'
       );
-
-      return Promise.resolve();
-    }
-
-    return this.request
-      .getActiveMeetings()
-      .then((locusArray) => {
-        const activeLocusUrl = [];
+    } else {
+      try {
+        const locusArray = await this.request.getActiveMeetings();
+        const activeLocusUrl: string[] = [];
 
         if (locusArray?.loci && locusArray.loci.length > 0) {
           const lociToUpdate = this.sortLocusArrayToUpdate(locusArray.loci);
+
           lociToUpdate.forEach((locus) => {
             activeLocusUrl.push(locus.url);
             this.handleLocusEvent({
@@ -1920,21 +1955,48 @@ export default class Meetings extends WebexPlugin {
           // (they had a locusUrl previously but are no longer active) in the sync
           for (const meeting of Object.values(meetingsCollection)) {
             // @ts-ignore
-            const {locusUrl} = meeting;
+            const {locusUrl, locusInfo} = meeting;
             if ((keepOnlyLocusMeetings || locusUrl) && !activeLocusUrl.includes(locusUrl)) {
-              // destroy function also uploads logs
-              // @ts-ignore
-              this.destroy(meeting, MEETING_REMOVED_REASON.NO_MEETINGS_TO_SYNC);
+              const globalMeetingId = locusInfo?.info?.globalMeetingId;
+
+              if (
+                globalMeetingId &&
+                locusArray?.loci?.some(
+                  (locus: LocusDTO) => locus.info?.globalMeetingId === globalMeetingId
+                )
+              ) {
+                // don't destroy the meeting as Locus API still returned some Locus that shares
+                // the same globalMeetingId - that happens for example if a webinar user (who hasn't scheduled it)
+                // is in a breakout and gets moved to a different breakout while we were offline
+              } else {
+                // destroy function also uploads logs
+                // @ts-ignore
+                this.destroy(meeting, MEETING_REMOVED_REASON.NO_MEETINGS_TO_SYNC);
+              }
             }
           }
         }
-      })
-      .catch((error) => {
+      } catch (error) {
         LoggerProxy.logger.error(
           `Meetings:index#syncMeetings --> failed to sync meetings, ${error}`
         );
-        throw new Error(error);
-      });
+        throw error;
+      }
+    }
+
+    // Trigger hash tree syncs for all remaining meetings
+    const remainingMeetings = this.meetingCollection.getAll();
+    const syncPromises = [];
+
+    for (const meeting of Object.values(remainingMeetings) as any[]) {
+      if (meeting.locusInfo) {
+        syncPromises.push(meeting.locusInfo.syncAllHashTreeDatasets());
+      }
+    }
+
+    if (syncPromises.length > 0) {
+      await Promise.all(syncPromises);
+    }
   }
 
   /**
@@ -1950,8 +2012,8 @@ export default class Meetings extends WebexPlugin {
     this.breakoutLocusForHandleLater = [];
     const lociToUpdate = [...mainLoci];
     breakoutLoci.forEach((breakoutLocus) => {
-      const associateMainLocus = mainLoci.find(
-        (mainLocus) => mainLocus.controls?.breakout?.url === breakoutLocus.controls?.breakout?.url
+      const associateMainLocus = mainLoci.find((mainLocus) =>
+        MeetingsUtil.isMainAssociatedWithBreakout(mainLocus, breakoutLocus)
       );
       const existCorrespondingMeeting = this.getCorrespondingMeetingByLocus({
         eventType: LOCUSEVENT.SDK_NO_EVENT,
@@ -1979,7 +2041,7 @@ export default class Meetings extends WebexPlugin {
    * @public
    * @memberof Meetings
    */
-  checkHandleBreakoutLocus(newCreatedLocus) {
+  checkHandleBreakoutLocus(newCreatedLocus: any) {
     if (
       !newCreatedLocus ||
       !this.breakoutLocusForHandleLater ||
@@ -1990,9 +2052,8 @@ export default class Meetings extends WebexPlugin {
     if (MeetingsUtil.isBreakoutLocusDTO(newCreatedLocus)) {
       return;
     }
-    const existIndex = this.breakoutLocusForHandleLater.findIndex(
-      (breakoutLocus) =>
-        breakoutLocus.controls?.breakout?.url === newCreatedLocus.controls?.breakout?.url
+    const existIndex = this.breakoutLocusForHandleLater.findIndex((breakoutLocus: any) =>
+      MeetingsUtil.isMainAssociatedWithBreakout(newCreatedLocus, breakoutLocus)
     );
 
     if (existIndex < 0) {

package/src/meetings/meetings.types.ts

@@ -31,3 +31,22 @@ export type MeetingRegistrationStatus = {
   mercuryConnect: boolean;
   checkH264Support: boolean;
 };
+
+export enum SitePreferenceSelectOption {
+  SCHEDULING = 'scheduling',
+}
+
+export type FetchSitePreferencesMeViaSiteOptions = {
+  siteUrl?: string;
+  siteName?: string;
+  selectOptions?: SitePreferenceSelectOption[];
+};
+
+export const DEFAULT_SITE_PREFERENCE_SELECT_OPTIONS = [SitePreferenceSelectOption.SCHEDULING];
+
+export type SitePreferencesResponse = {
+  scheduling?: {
+    supportScheduleWebinar?: boolean;
+    webinarWebLink?: string;
+  };
+};

package/src/meetings/request.ts

@@ -2,7 +2,14 @@
 import {StatelessWebexPlugin} from '@webex/webex-core';
 
 import LoggerProxy from '../common/logs/logger-proxy';
+import ParameterError from '../common/errors/parameter';
 import {HTTP_VERBS, API, RESOURCE} from '../constants';
+import {
+  DEFAULT_SITE_PREFERENCE_SELECT_OPTIONS,
+  type FetchSitePreferencesMeViaSiteOptions,
+  type SitePreferencesResponse,
+} from './meetings.types';
+import MeetingsUtil from './util';
 
 /**
  * @class MeetingRequest
@@ -45,6 +52,42 @@ export default class MeetingRequest extends StatelessWebexPlugin {
     return this.webex.internal.services.getMeetingPreferences();
   }
 
+  /**
+   * Fetches site preferences from a given site given a select option and a siteUrl with an optional siteName. If siteName is not provided, it will be derived from the siteUrl. If siteUrl is not provided, it will throw an error. If selectOptions is not provided, it will default to scheduling.
+   *
+   * @param {object} [options]
+   * @param {string} [options.siteUrl] - Webex site URL, for example "cisco.webex.com".
+   * @param {string} [options.siteName] - Site name query override. Defaults to the site name derived from options.siteUrl, e.g., "cisco".
+   * @param {SitePreferenceSelectOption[]} [options.selectOptions] - Preference sections to fetch. Defaults to 'scheduling'.
+   * @returns {Promise<SitePreferencesResponse>} site preferences response body
+   * @throws {ParameterError}
+   * @public
+   * @memberof MeetingRequest
+   */
+  fetchSitePreferencesMeViaSite(
+    options: FetchSitePreferencesMeViaSiteOptions = {}
+  ): Promise<SitePreferencesResponse> {
+    const {siteUrl, selectOptions = DEFAULT_SITE_PREFERENCE_SELECT_OPTIONS} = options;
+
+    if (!siteUrl) {
+      throw new ParameterError(
+        'No siteUrl available. Call register() before fetching site preferences or provide options.siteUrl.'
+      );
+    }
+
+    // @ts-ignore - config comes from registerPlugin
+    const multipartSitePrefixList = this.config.meetings.multipartSitePrefixList || [];
+    const siteName = options.siteName || MeetingsUtil.getSiteName(siteUrl, multipartSitePrefixList);
+
+    // @ts-ignore
+    return this.request({
+      method: HTTP_VERBS.GET,
+      uri: `https://${siteUrl}/wbxappapi/v1/users/me/preference?select=${encodeURIComponent(
+        selectOptions.join(',')
+      )}&siteurl=${encodeURIComponent(siteName)}`,
+    }).then((res: any) => res.body);
+  }
+
   // locus federation, determines and populate locus if the responseBody has remote URLs to fetch locus details
 
   /**

package/src/meetings/util.ts

@@ -18,6 +18,7 @@ import Trigger from '../common/events/trigger-proxy';
 import BEHAVIORAL_METRICS from '../metrics/constants';
 import Metrics from '../metrics';
 import {MEETING_KEY} from './meetings.types';
+import {EndMeetingReason, LocusFullState} from '../locus-info/types';
 
 /**
  * Meetings Media Codec Missing Event
@@ -152,6 +153,30 @@ MeetingsUtil.parseDefaultSiteFromMeetingPreferences = (userPreferences) => {
   return result;
 };
 
+MeetingsUtil.getSiteName = (site: string, multipartSitePrefixList: string[] = []) => {
+  if (!site) {
+    return null;
+  }
+
+  let siteName: string | undefined;
+
+  multipartSitePrefixList.forEach((multipartSitePrefix) => {
+    if (!siteName && site.includes(multipartSitePrefix)) {
+      const secondDot = site.indexOf('.', site.indexOf('.') + 1);
+
+      siteName = site.substring(0, secondDot);
+    }
+  });
+
+  if (siteName) {
+    return siteName;
+  }
+
+  siteName = site.substring(0, site.indexOf('.'));
+
+  return siteName;
+};
+
 /**
  * Will check to see if the H.264 media codec is supported.
  * @async
@@ -266,6 +291,35 @@ MeetingsUtil.getThisDevice = (newLocus: any, deviceUrl: string) => {
   return null;
 };
 
+/**
+ * Checks if the fullState indicates the meeting has fully ended (not just a breakout move).
+ * @param {Object} fullState locus fullState data
+ * @returns {boolean}
+ */
+MeetingsUtil.isWholeMeetingEnded = (fullState: LocusFullState): boolean => {
+  return (
+    fullState.state === LOCUS.STATE.INACTIVE &&
+    fullState.endMeetingReason !== EndMeetingReason.breakoutEnded
+  );
+};
+
+/**
+ * Checks if the self state in a locus indicates a breakout move or breakout end.
+ * Returns true when:
+ * - self state is LEFT with reason MOVED (regular breakout move), OR
+ * - fullState is INACTIVE with endMeetingReason BREAKOUT_ENDED (breakout session ended)
+ * @param {Object} locus locus data
+ * @returns {boolean}
+ */
+MeetingsUtil.isSelfMovedOrBreakoutEnded = (locus: any): boolean => {
+  const isSelfLeftMoved = locus?.self?.state === _LEFT_ && locus?.self?.reason === _MOVED_;
+  const isBreakoutEnded =
+    locus?.fullState?.state === LOCUS.STATE.INACTIVE &&
+    locus?.fullState?.endMeetingReason === EndMeetingReason.breakoutEnded;
+
+  return isSelfLeftMoved || isBreakoutEnded;
+};
+
 /**
  * get self device joined status from locus data
  * @param {Object} meeting current meeting data
@@ -294,7 +348,10 @@ MeetingsUtil.joinedOnThisDevice = (meeting: any, newLocus: any, deviceUrl: strin
  * @private
  */
 MeetingsUtil.isBreakoutLocusDTO = (newLocus: any) => {
-  return newLocus?.controls?.breakout?.sessionType === BREAKOUTS.SESSION_TYPES.BREAKOUT;
+  return (
+    newLocus?.controls?.breakout?.sessionType === BREAKOUTS.SESSION_TYPES.BREAKOUT ||
+    !!newLocus?.info?.isBreakout
+  );
 };
 
 /**
@@ -310,4 +367,26 @@ MeetingsUtil.isValidBreakoutLocus = (locus: any) => {
 
   return isLocusAsBreakout && !inActiveStatus && selfJoined;
 };
+/**
+ * check if the breakout locus is associated with the main locus by comparing the breakout control url or the replaces info in self device
+ * @param {Object} mainLocus main locus data
+ * @param {Object} breakoutLocus breakout locus data
+ * @returns {boolean}
+ * @private
+ */
+MeetingsUtil.isMainAssociatedWithBreakout = (mainLocus: any, breakoutLocus: any) => {
+  if (
+    mainLocus.controls?.breakout?.url &&
+    mainLocus.controls?.breakout?.url === breakoutLocus.controls?.breakout?.url
+  ) {
+    return true;
+  }
+  const deviceUrl = breakoutLocus?.self?.deviceUrl;
+  const replaceInfo = MeetingsUtil.getThisDevice(breakoutLocus, deviceUrl)?.replaces?.[0];
+  if (replaceInfo?.locusUrl && replaceInfo.locusUrl === mainLocus.url) {
+    return true;
+  }
+
+  return false;
+};
 export default MeetingsUtil;

package/src/member/index.ts

@@ -27,6 +27,7 @@ export default class Member {
   isModerator: any;
   isModeratorAssignmentProhibited: any;
   isPresenterAssignmentProhibited: any;
+  isAttendeeAssignmentProhibited: any;
   isMutable: any;
   isNotAdmitted: any;
   isRecording: any;
@@ -292,6 +293,14 @@ export default class Member {
      */
     this.isPresenterAssignmentProhibited = null;
 
+    /**
+     * @instance
+     * @type {Boolean}
+     * @public
+     * @memberof Member
+     */
+    this.isAttendeeAssignmentProhibited = null;
+
     /**
      * @instance
      * @type {Boolean}
@@ -369,6 +378,7 @@ export default class Member {
         MemberUtil.isModeratorAssignmentProhibited(participant);
       this.isPresenterAssignmentProhibited =
         MemberUtil.isPresenterAssignmentProhibited(participant);
+      this.isAttendeeAssignmentProhibited = MemberUtil.isAttendeeAssignmentProhibited(participant);
       this.canApproveAIEnablement = MemberUtil.canApproveAIEnablement(participant);
       this.processStatus(participant);
       this.processRoles(participant);

package/src/member/types.ts

@@ -103,6 +103,7 @@ export interface Participant {
   moderator: boolean; // Locus docs say this is deprecated and role control should be used instead
   moderatorAssignmentNotAllowed: boolean;
   presenterAssignmentNotAllowed: boolean;
+  attendeeAssignmentNotAllowed?: boolean;
   person: ParticipantPerson;
   resourceGuest: boolean;
   state: string; // probably one of MEETING_STATE.STATES

package/src/member/util.ts

@@ -140,6 +140,9 @@ const MemberUtil = {
   isPresenterAssignmentProhibited: (participant: Participant) =>
     participant && participant.presenterAssignmentNotAllowed,
 
+  isAttendeeAssignmentProhibited: (participant: Participant) =>
+    !!(participant && participant.attendeeAssignmentNotAllowed),
+
   /**
    * checks to see if the participant id is the same as the passed id
    * there are multiple ids that can be used

package/src/metrics/constants.ts

@@ -96,6 +96,7 @@ const BEHAVIORAL_METRICS = {
   SET_CUSTOM_CODEC_PARAMETERS_USED: 'js_sdk_set_custom_codec_parameters_used',
   MARK_CUSTOM_CODEC_PARAMETERS_FOR_DELETION_USED:
     'js_sdk_mark_custom_codec_parameters_for_deletion_used',
+  HASH_TREE_SYNC_FAILURE: 'js_sdk_hash_tree_sync_failure',
 };
 
 export {BEHAVIORAL_METRICS as default};

package/src/recording-controller/index.ts

@@ -261,8 +261,7 @@ export default class RecordingController {
 
     LoggerProxy.logger.log(`RecordingController:index#recordingControls --> ${record}`);
 
-    // @ts-ignore
-    return this.request.request({
+    return this.request.locusDeltaRequest({
       uri: `${this.locusUrl}/${CONTROLS}`,
       body: {
         record,