@webex/plugin-meetings 3.9.0-next.10 → 3.9.0-next.12

package/dist/types/meeting/util.d.ts

@@ -14,6 +14,12 @@ declare const MeetingUtil: {
      * @returns {IP_VERSION|undefined} ipver value to be passed to the backend APIs or undefined if we should not pass any value to the backend
      */
     getIpVersion(webex: any): IP_VERSION | undefined;
+    /**
+     * 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;
     joinMeeting: (meeting: any, options: any) => Promise<any>;
     cleanUp: (meeting: any) => any;
     disconnectPhoneAudio: (meeting: any, phoneUrl: any) => any;

package/dist/types/meeting-info/meeting-info-v2.d.ts

@@ -187,20 +187,22 @@ 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
      */
-    createAdhocSpaceMeetingOrEnableStaticMeetingLink(conversationUrl: string, installedOrgID?: string, enableStaticMeetingLink?: boolean): Promise<any>;
+    createAdhocSpaceMeetingOrEnableStaticMeetingLink(conversationUrl: string, installedOrgID?: string, enableStaticMeetingLink?: boolean, classificationId?: any): Promise<any>;
     /**
      * 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
      */
-    createAdhocSpaceMeeting(conversationUrl: string, installedOrgID?: string): Promise<any>;
+    createAdhocSpaceMeeting(conversationUrl: string, installedOrgID?: string, classificationId?: string): Promise<any>;
     /**
      * Fetches details for static meeting link
      * @param {String} conversationUrl conversationUrl that's required to find static meeting link if it exists
@@ -239,6 +241,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
@@ -249,5 +252,5 @@ export default class MeetingInfoV2 {
     }, installedOrgID?: any, locusId?: any, extraParams?: object, options?: {
         meetingId?: string;
         sendCAevents?: boolean;
-    }, registrationId?: string, fullSiteUrl?: string): Promise<any>;
+    }, registrationId?: string, fullSiteUrl?: string, classificationId?: string): Promise<any>;
 }

package/dist/types/meetings/index.d.ts

@@ -400,11 +400,12 @@ 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
      */
-    create(destination: string, type?: DESTINATION_TYPE, useRandomDelayForInfo?: boolean, infoExtraParams?: {}, correlationId?: string, failOnMissingMeetingInfo?: boolean, callStateForMetrics?: CallStateForMetrics, meetingInfo?: any, meetingLookupUrl?: any, sessionCorrelationId?: string): any;
+    create(destination: string, type?: DESTINATION_TYPE, useRandomDelayForInfo?: boolean, infoExtraParams?: {}, correlationId?: string, failOnMissingMeetingInfo?: boolean, callStateForMetrics?: CallStateForMetrics, meetingInfo?: any, meetingLookupUrl?: any, sessionCorrelationId?: string, classificationId?: string): any;
     /**
      * Enable static meeting links for given conversation url.
      *
@@ -438,6 +439,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

package/dist/webinar/index.js

@@ -458,7 +458,7 @@ var Webinar = _webexCore.WebexPlugin.extend({
       }, _callee7);
     }))();
   },
-  version: "3.9.0-next.10"
+  version: "3.9.0-next.12"
 });
 var _default = exports.default = Webinar;
 //# sourceMappingURL=index.js.map

package/package.json

@@ -92,5 +92,5 @@
   "//": [
     "TODO: upgrade jwt-decode when moving to node 18"
   ],
-  "version": "3.9.0-next.10"
+  "version": "3.9.0-next.12"
 }

package/src/meeting/index.ts

@@ -269,6 +269,7 @@ export enum ScreenShareFloorStatus {
 type FetchMeetingInfoParams = {
   password?: string;
   registrationId?: string;
+  classificationId?: string;
   captchaCode?: string;
   extraParams?: Record<string, any>;
   sendCAevents?: boolean;
@@ -1902,6 +1903,7 @@ export default class Meeting extends StatelessWebexPlugin {
     extraParams = {},
     sendCAevents = false,
     registrationId = null,
+    classificationId = null,
   }): Promise<void> {
     try {
       const captchaInfo = captchaCode
@@ -1918,7 +1920,9 @@ export default class Meeting extends StatelessWebexPlugin {
         this.locusId,
         extraParams,
         {meetingId: this.id, sendCAevents},
-        registrationId
+        registrationId,
+        null,
+        classificationId
       );
 
       this.parseMeetingInfo(info?.body, this.destination, info?.errors);
@@ -6796,6 +6800,10 @@ export default class Meeting extends StatelessWebexPlugin {
             // @ts-ignore
             this.webex.internal.newMetrics.submitClientEvent({
               name: 'client.ice.start',
+              payload: {
+                // @ts-ignore
+                labels: MeetingUtil.getCaEventLabelsForIpVersion(this.webex),
+              },
               options: {
                 meetingId: this.id,
               },

package/src/meeting/util.ts

@@ -115,6 +115,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.'));

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(
       {
@@ -1589,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/test/unit/spec/meeting/index.js

@@ -7478,6 +7478,8 @@ describe('plugin-meetings', () => {
             'locus-id',
             {extraParam1: 'value1', permissionToken: FAKE_PERMISSION_TOKEN},
             {meetingId: meeting.id, sendCAevents: true},
+            null,
+            null,
             null
           );
           assert.deepEqual(meeting.meetingInfo, {
@@ -7524,6 +7526,8 @@ describe('plugin-meetings', () => {
             'locus-id',
             {extraParam1: 'value1', permissionToken: FAKE_PERMISSION_TOKEN},
             {meetingId: meeting.id, sendCAevents: true},
+            null,
+            null,
             null
           );
           assert.deepEqual(meeting.meetingInfo, {
@@ -7579,6 +7583,8 @@ describe('plugin-meetings', () => {
               permissionToken: FAKE_PERMISSION_TOKEN,
             },
             {meetingId: meeting.id, sendCAevents: true},
+            null,
+            null,
             null
           );
           assert.deepEqual(meeting.meetingInfo, {
@@ -9020,11 +9026,16 @@ describe('plugin-meetings', () => {
             meeting.hasMediaConnectionConnectedAtLeastOnce = false;
             meeting.setupMediaConnectionListeners();
 
+            sinon.stub(MeetingUtil, 'getCaEventLabelsForIpVersion').returns(['fake labels']);
+
             simulateConnectionStateChange(ConnectionState.Connecting);
 
             assert.calledOnce(webex.internal.newMetrics.submitClientEvent);
             assert.calledWithMatch(webex.internal.newMetrics.submitClientEvent, {
               name: 'client.ice.start',
+              payload: {
+                labels: ['fake labels'],
+              },
               options: {
                 meetingId: meeting.id,
               },

package/test/unit/spec/meeting/utils.js

@@ -1310,6 +1310,27 @@ describe('plugin-meetings', () => {
       });
     });
 
+    describe('getCaEventLabelsForIpVersion', () => {
+      [
+        {ipver: IP_VERSION.unknown, expectedLabels: undefined},
+        {ipver: IP_VERSION.only_ipv4, expectedLabels: ['hasIpv4_true']},
+        {ipver: IP_VERSION.only_ipv6, expectedLabels: ['hasIpv6_true']},
+        {
+          ipver: IP_VERSION.ipv4_and_ipv6,
+          expectedLabels: ['hasIpv4_true', 'hasIpv6_true'],
+        },
+      ].forEach(({ipver, expectedLabels}) => {
+        it(`returns expected labels when ipver=${ipver}`, () => {
+          sinon.stub(MeetingUtil, 'getIpVersion').returns(ipver);
+
+          const result = MeetingUtil.getCaEventLabelsForIpVersion(webex);
+
+          assert.calledOnceWithExactly(MeetingUtil.getIpVersion, webex);
+          assert.deepEqual(result, expectedLabels);
+        });
+      });
+    });
+
     describe('getChangeMeetingFloorErrorPayload', () => {
       [
         {

package/test/unit/spec/meeting-info/meetinginfov2.js

@@ -218,6 +218,7 @@ describe('plugin-meetings', () => {
             invitees: invitee,
             installedOrgID: undefined,
             schedule: true,
+            classificationId: undefined,
           },
         });
 
@@ -652,7 +653,8 @@ describe('plugin-meetings', () => {
         assert.calledOnceWithExactly(
           meetingInfo.createAdhocSpaceMeeting,
           'conversationUrl',
-          installedOrgID
+          installedOrgID,
+          null,
         );
         assert.notCalled(webex.request);
         meetingInfo.createAdhocSpaceMeeting.restore();
@@ -1148,6 +1150,7 @@ describe('plugin-meetings', () => {
     describe('createAdhocSpaceMeeting', () => {
       const conversationUrl = 'https://conversationUrl/xxx';
       const installedOrgID = '12345';
+      const classificationId = '123456';
 
       const setup = () => {
         const invitee = [];
@@ -1173,7 +1176,7 @@ describe('plugin-meetings', () => {
           body: conversation,
         });
 
-        const result = await meetingInfo.createAdhocSpaceMeeting(conversationUrl, installedOrgID);
+        const result = await meetingInfo.createAdhocSpaceMeeting(conversationUrl, installedOrgID, classificationId);
 
         assert.calledWith(webex.request, {
           uri: conversationUrl,
@@ -1192,6 +1195,7 @@ describe('plugin-meetings', () => {
             invitees: invitee,
             installedOrgID: installedOrgID,
             schedule: false,
+            classificationId,
           },
         });
         assert.calledOnce(Metrics.sendBehavioralMetric);
@@ -1206,7 +1210,7 @@ describe('plugin-meetings', () => {
         webex.request = sinon.stub().resolves({
           body: conversation,
         });
-        await meetingInfo.createAdhocSpaceMeeting(conversationUrl, installedOrgID);
+        await meetingInfo.createAdhocSpaceMeeting(conversationUrl, installedOrgID, classificationId);
 
         assert.calledWith(webex.request, {
           uri: conversationUrl,
@@ -1224,6 +1228,7 @@ describe('plugin-meetings', () => {
             invitees: invitee,
             installedOrgID,
             schedule: false,
+            classificationId,
           },
         });
         assert(Metrics.sendBehavioralMetric.calledOnce);

package/test/unit/spec/meetings/index.js

@@ -1099,6 +1099,7 @@ describe('plugin-meetings', () => {
         const FAKE_USE_RANDOM_DELAY = true;
         const correlationId = 'my-correlationId';
         const sessionCorrelationId = 'my-session-correlationId';
+        const classificationId = 'my-classificationId';
         const callStateForMetrics = {
           sessionCorrelationId: 'my-session-correlationId2',
           correlationId: 'my-correlationId2',
@@ -1119,7 +1120,8 @@ describe('plugin-meetings', () => {
             callStateForMetrics,
             undefined,
             undefined,
-            sessionCorrelationId
+            sessionCorrelationId,
+            classificationId
           );
           assert.calledOnceWithExactly(fakeMeeting.updateCallStateForMetrics, {
             ...callStateForMetrics,
@@ -1201,6 +1203,13 @@ describe('plugin-meetings', () => {
           );
         });
 
+        it('calls createMeeting with classificationId and returns its promise', async () => {
+          await checkCallCreateMeeting(
+            [test1, test2, FAKE_USE_RANDOM_DELAY, {}, undefined, true, callStateForMetrics, undefined, undefined, undefined, classificationId],
+            [test1, test2, FAKE_USE_RANDOM_DELAY, {}, callStateForMetrics, true, undefined, undefined, classificationId],
+          );
+        });
+
         it('calls createMeeting with callStateForMetrics overwritten with correlationId and returns its promise', async () => {
           await checkCallCreateMeeting(
             [test1, test2, FAKE_USE_RANDOM_DELAY, {}, correlationId, true, callStateForMetrics],