@webex/plugin-meetings 3.7.0 → 3.8.0

package/dist/meetings/index.js

@@ -59,9 +59,10 @@ var _collection = _interopRequireDefault(require("./collection"));
 var _meetings = require("./meetings.types");
 var _util2 = _interopRequireDefault(require("./util"));
 var _permission = _interopRequireDefault(require("../common/errors/permission"));
-var _webinarRegistrationError = _interopRequireDefault(require("../common/errors/webinar-registration-error"));
+var _joinWebinarError = _interopRequireDefault(require("../common/errors/join-webinar-error"));
 var _webexErrors = require("../common/errors/webex-errors");
 var _noMeetingInfo = _interopRequireDefault(require("../common/errors/no-meeting-info"));
+var _joinForbiddenError = _interopRequireDefault(require("../common/errors/join-forbidden-error"));
 function _getRequireWildcardCache(e) { if ("function" != typeof _WeakMap) return null; var r = new _WeakMap(), t = new _WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(e) { return e ? t : r; })(e); }
 function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != _typeof(e) && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = _Object$defineProperty && _Object$getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? _Object$getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? _Object$defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
 function ownKeys(e, r) { var t = _Object$keys2(e); if (_Object$getOwnPropertySymbols) { var o = _Object$getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return _Object$getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
@@ -203,6 +204,7 @@ var Meetings = exports.default = /*#__PURE__*/function (_WebexPlugin) {
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "mediaHelpers", void 0);
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "breakoutLocusForHandleLater", void 0);
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "namespace", _constants.MEETINGS);
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "registrationStatus", void 0);
     /**
      * Creates a noise reduction effect
      *
@@ -693,6 +695,22 @@ var Meetings = exports.default = /*#__PURE__*/function (_WebexPlugin) {
       });
     }
 
+    /**
+     * API to change log upload interval. Setting the factor to 0 will disable periodic log uploads.
+     *
+     * @param {number} factor new factor value
+     * @returns {void}
+     */
+  }, {
+    key: "_setLogUploadIntervalMultiplicationFactor",
+    value: function _setLogUploadIntervalMultiplicationFactor(factor) {
+      if (typeof factor !== 'number') {
+        return;
+      }
+      // @ts-ignore
+      this.config.logUploadIntervalMultiplicationFactor = factor;
+    }
+
     /**
      * API to toggle unified meetings
      * @param {Boolean} changeState
@@ -798,6 +816,21 @@ var Meetings = exports.default = /*#__PURE__*/function (_WebexPlugin) {
       }
     }
 
+    /**
+     * Executes a registration step and updates the registration status.
+     * @param {Function} step - The registration step to execute.
+     * @param {string} stepName - The name of the registration step.
+     * @returns {Promise} A promise that resolves when the step is completed.
+     */
+  }, {
+    key: "executeRegistrationStep",
+    value: function executeRegistrationStep(step, stepName) {
+      var _this5 = this;
+      return step().then(function () {
+        _this5.registrationStatus[stepName] = true;
+      });
+    }
+
     /**
      * Explicitly sets up the meetings plugin by registering
      * the device, connecting to mercury, and listening for locus events.
@@ -810,7 +843,9 @@ var Meetings = exports.default = /*#__PURE__*/function (_WebexPlugin) {
   }, {
     key: "register",
     value: function register(deviceRegistrationOptions) {
-      var _this5 = this;
+      var _this6 = this;
+      this.registrationStatus = (0, _lodash.clone)(_constants.INITIAL_REGISTRATION_STATUS);
+
       // @ts-ignore
       if (!this.webex.canAuthorize) {
         _loggerProxy.default.logger.error('Meetings:index#register --> ERROR, Unable to register, SDK cannot authorize');
@@ -820,26 +855,39 @@ var Meetings = exports.default = /*#__PURE__*/function (_WebexPlugin) {
         _loggerProxy.default.logger.info('Meetings:index#register --> INFO, Meetings plugin already registered');
         return _promise.default.resolve();
       }
-      return _promise.default.all([this.fetchUserPreferredWebexSite(), this.getGeoHint(), this.startReachability('registration').catch(function (error) {
-        _loggerProxy.default.logger.error("Meetings:index#register --> GDM error, ".concat(error.message));
-      }),
-      // @ts-ignore
-      this.webex.internal.device.register(deviceRegistrationOptions)
-      // @ts-ignore
-      .then(function () {
-        return _loggerProxy.default.logger.info( // @ts-ignore
-        "Meetings:index#register --> INFO, Device registered ".concat(_this5.webex.internal.device.url));
-      })
-      // @ts-ignore
-      .then(function () {
-        return _this5.webex.internal.mercury.connect();
-      }), _util2.default.checkH264Support.call(this)]).then(function () {
-        _this5.listenForEvents();
-        _triggerProxy.default.trigger(_this5, {
+      return _promise.default.all([this.executeRegistrationStep(function () {
+        return _this6.fetchUserPreferredWebexSite();
+      }, 'fetchWebexSite'), this.executeRegistrationStep(function () {
+        return _this6.getGeoHint();
+      }, 'getGeoHint'), this.executeRegistrationStep(function () {
+        return _this6.startReachability('registration').catch(function (error) {
+          _loggerProxy.default.logger.error("Meetings:index#register --> GDM error, ".concat(error.message));
+        });
+      }, 'startReachability'), this.executeRegistrationStep(function () {
+        return (
+          // @ts-ignore
+          _this6.webex.internal.device.register(deviceRegistrationOptions)
+          // @ts-ignore
+          .then(function () {
+            _loggerProxy.default.logger.info( // @ts-ignore
+            "Meetings:index#register --> INFO, Device registered ".concat(_this6.webex.internal.device.url));
+          })
+        );
+      }, 'deviceRegister').then(function () {
+        return _this6.executeRegistrationStep(
+        // @ts-ignore
+        function () {
+          return _this6.webex.internal.mercury.connect();
+        }, 'mercuryConnect');
+      }), this.executeRegistrationStep(function () {
+        return _promise.default.resolve(_util2.default.checkH264Support.call(_this6));
+      }, 'checkH264Support')]).then(function () {
+        _this6.listenForEvents();
+        _triggerProxy.default.trigger(_this6, {
           file: 'meetings',
           function: 'register'
         }, _constants.EVENT_TRIGGERS.MEETINGS_REGISTERED);
-        _this5.registered = true;
+        _this6.registered = true;
         _metrics.default.sendBehavioralMetric(_constants2.default.MEETINGS_REGISTRATION_SUCCESS);
       }).catch(function (error) {
         _loggerProxy.default.logger.error("Meetings:index#register --> ERROR, Unable to register, ".concat(error.message));
@@ -862,7 +910,7 @@ var Meetings = exports.default = /*#__PURE__*/function (_WebexPlugin) {
   }, {
     key: "unregister",
     value: function unregister() {
-      var _this6 = this;
+      var _this7 = this;
       if (!this.registered) {
         _loggerProxy.default.logger.info('Meetings:index#unregister --> INFO, Meetings plugin already unregistered');
         return _promise.default.resolve();
@@ -873,13 +921,14 @@ var Meetings = exports.default = /*#__PURE__*/function (_WebexPlugin) {
         this.webex.internal.mercury.disconnect()
         // @ts-ignore
         .then(function () {
-          return _this6.webex.internal.device.unregister();
+          return _this7.webex.internal.device.unregister();
         }).then(function () {
-          _triggerProxy.default.trigger(_this6, {
+          _triggerProxy.default.trigger(_this7, {
             file: 'meetings',
             function: 'unregister'
           }, _constants.EVENT_TRIGGERS.MEETINGS_UNREGISTERED);
-          _this6.registered = false;
+          _this7.registered = false;
+          _this7.registrationStatus = (0, _lodash.clone)(_constants.INITIAL_REGISTRATION_STATUS);
         })
       );
     }
@@ -899,13 +948,13 @@ var Meetings = exports.default = /*#__PURE__*/function (_WebexPlugin) {
      * @returns {String} feedback ID logs were submitted under
      */
     function uploadLogs() {
-      var _this7 = this;
+      var _this8 = this;
       var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
       _loggerProxy.default.logger.info('Meetings:index#uploadLogs --> uploading logs');
       return this.loggerRequest.uploadLogs(options).then(function (uploadResult) {
         _loggerProxy.default.logger.info('Meetings:index#uploadLogs --> Upload logs for meeting completed.', uploadResult);
         _metrics.default.sendBehavioralMetric(_constants2.default.UPLOAD_LOGS_SUCCESS, options);
-        _triggerProxy.default.trigger(_this7, {
+        _triggerProxy.default.trigger(_this8, {
           file: 'meetings',
           function: 'uploadLogs'
         }, _constants.EVENT_TRIGGERS.MEETING_LOG_UPLOAD_SUCCESS, {
@@ -915,7 +964,7 @@ var Meetings = exports.default = /*#__PURE__*/function (_WebexPlugin) {
         return uploadResult;
       }).catch(function (uploadError) {
         _loggerProxy.default.logger.error('Meetings:index#uploadLogs --> Unable to upload logs for meeting', uploadError);
-        _triggerProxy.default.trigger(_this7, {
+        _triggerProxy.default.trigger(_this8, {
           file: 'meetings',
           function: 'uploadLogs'
         }, _constants.EVENT_TRIGGERS.MEETING_LOG_UPLOAD_FAILURE, {
@@ -965,9 +1014,9 @@ var Meetings = exports.default = /*#__PURE__*/function (_WebexPlugin) {
   }, {
     key: "getGeoHint",
     value: function getGeoHint() {
-      var _this8 = this;
+      var _this9 = this;
       return this.request.fetchGeoHint().then(function (res) {
-        _this8.geoHintInfo = res;
+        _this9.geoHintInfo = res;
       });
     }
 
@@ -981,29 +1030,29 @@ var Meetings = exports.default = /*#__PURE__*/function (_WebexPlugin) {
   }, {
     key: "fetchUserPreferredWebexSite",
     value: function fetchUserPreferredWebexSite() {
-      var _this9 = this;
+      var _this10 = this;
       // @ts-ignore
       return this.webex.people._getMe().then(function (me) {
         var isGuestUser = me.type === 'appuser';
         if (!isGuestUser) {
-          return _this9.request.getMeetingPreferences().then(function (res) {
+          return _this10.request.getMeetingPreferences().then(function (res) {
             if (res) {
               var preferredWebexSite = _util2.default.parseDefaultSiteFromMeetingPreferences(res);
-              _this9.preferredWebexSite = preferredWebexSite;
+              _this10.preferredWebexSite = preferredWebexSite;
               // @ts-ignore
-              _this9.webex.internal.services._getCatalog().addAllowedDomains([preferredWebexSite]);
+              _this10.webex.internal.services._getCatalog().addAllowedDomains([preferredWebexSite]);
             }
 
             // fall back to getting the preferred site from the user information
-            if (!_this9.preferredWebexSite) {
+            if (!_this10.preferredWebexSite) {
               // @ts-ignore
-              return _this9.webex.internal.user.get().then(function (user) {
+              return _this10.webex.internal.user.get().then(function (user) {
                 var _user$userPreferences, _user$userPreferences2;
                 var preferredWebexSite = user === null || user === void 0 ? void 0 : (_user$userPreferences = user.userPreferences) === null || _user$userPreferences === void 0 ? void 0 : (_user$userPreferences2 = _user$userPreferences.userPreferencesItems) === null || _user$userPreferences2 === void 0 ? void 0 : _user$userPreferences2.preferredWebExSite;
                 if (preferredWebexSite) {
-                  _this9.preferredWebexSite = preferredWebexSite;
+                  _this10.preferredWebexSite = preferredWebexSite;
                   // @ts-ignore
-                  _this9.webex.internal.services._getCatalog().addAllowedDomains([preferredWebexSite]);
+                  _this10.webex.internal.services._getCatalog().addAllowedDomains([preferredWebexSite]);
                 } else {
                   throw new Error('site not found');
                 }
@@ -1074,7 +1123,10 @@ var Meetings = exports.default = /*#__PURE__*/function (_WebexPlugin) {
             lastActive: (_meeting$locusInfo2 = meeting.locusInfo) === null || _meeting$locusInfo2 === void 0 ? void 0 : (_meeting$locusInfo2$f = _meeting$locusInfo2.fullState) === null || _meeting$locusInfo2$f === void 0 ? void 0 : _meeting$locusInfo2$f.lastActive,
             sessionId: (_meeting$locusInfo3 = meeting.locusInfo) === null || _meeting$locusInfo3 === void 0 ? void 0 : (_meeting$locusInfo3$f = _meeting$locusInfo3.fullState) === null || _meeting$locusInfo3$f === void 0 ? void 0 : _meeting$locusInfo3$f.sessionId
           }
-        }
+        },
+        roles: meeting.roles,
+        callStateForMetrics: meeting.callStateForMetrics,
+        getCurUserType: meeting.getCurUserType
       });
       this.meetingCollection.delete(meeting.id);
       _triggerProxy.default.trigger(this, {
@@ -1108,7 +1160,7 @@ var Meetings = exports.default = /*#__PURE__*/function (_WebexPlugin) {
   }, {
     key: "create",
     value: function create(destination) {
-      var _this10 = this;
+      var _this11 = this;
       var type = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : null;
       var useRandomDelayForInfo = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : false;
       var infoExtraParams = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : {};
@@ -1148,7 +1200,7 @@ var Meetings = exports.default = /*#__PURE__*/function (_WebexPlugin) {
         // check for the conversation URL then sip Url
         var meeting = null;
         if (type === _constants.DESTINATION_TYPE.CONVERSATION_URL || options.type === _constants.DESTINATION_TYPE.CONVERSATION_URL) {
-          var foundMeeting = _this10.meetingCollection.getByKey(_meetings.MEETING_KEY.CONVERSATION_URL, targetDest);
+          var foundMeeting = _this11.meetingCollection.getByKey(_meetings.MEETING_KEY.CONVERSATION_URL, targetDest);
           if (foundMeeting) {
             var foundMeetingIsNotCalendarMeeting = !foundMeeting.locusInfo.scheduledMeeting;
 
@@ -1162,21 +1214,21 @@ var Meetings = exports.default = /*#__PURE__*/function (_WebexPlugin) {
 
         // Attempt to collect the meeting if it exists.
         if (!meeting) {
-          meeting = _this10.meetingCollection.getByKey(_meetings.MEETING_KEY.SIP_URI, targetDest);
+          meeting = _this11.meetingCollection.getByKey(_meetings.MEETING_KEY.SIP_URI, targetDest);
         }
 
         // Validate if a meeting was found.
         if (!meeting) {
           // Create a meeting based on the normalized destination and type.
-          return _this10.createMeeting(targetDest, type, useRandomDelayForInfo, infoExtraParams, callStateForMetrics, failOnMissingMeetingInfo, meetingInfo, meetingLookupUrl).then(function (createdMeeting) {
+          return _this11.createMeeting(targetDest, type, useRandomDelayForInfo, infoExtraParams, callStateForMetrics, failOnMissingMeetingInfo, meetingInfo, meetingLookupUrl).then(function (createdMeeting) {
             // If the meeting was successfully created.
             if (createdMeeting && createdMeeting.on) {
               // Create a destruction event for the meeting.
               createdMeeting.on(_constants.EVENTS.DESTROY_MEETING, function (payload) {
                 // @ts-ignore
-                if (_this10.config.autoUploadLogs) {
+                if (_this11.config.autoUploadLogs) {
                   var _createdMeeting$locus, _createdMeeting$locus2, _createdMeeting$locus3, _createdMeeting$locus4, _createdMeeting$locus5, _createdMeeting$locus6;
-                  _this10.uploadLogs({
+                  _this11.uploadLogs({
                     callStart: (_createdMeeting$locus = createdMeeting.locusInfo) === null || _createdMeeting$locus === void 0 ? void 0 : (_createdMeeting$locus2 = _createdMeeting$locus.fullState) === null || _createdMeeting$locus2 === void 0 ? void 0 : _createdMeeting$locus2.lastActive,
                     locussessionid: (_createdMeeting$locus3 = createdMeeting.locusInfo) === null || _createdMeeting$locus3 === void 0 ? void 0 : (_createdMeeting$locus4 = _createdMeeting$locus3.fullState) === null || _createdMeeting$locus4 === void 0 ? void 0 : _createdMeeting$locus4.sessionId,
                     correlationId: createdMeeting.correlationId,
@@ -1186,13 +1238,13 @@ var Meetings = exports.default = /*#__PURE__*/function (_WebexPlugin) {
                     autoupload: true
                   });
                 }
-                _this10.destroy(createdMeeting, payload.reason);
+                _this11.destroy(createdMeeting, payload.reason);
               });
               createdMeeting.on(_constants.EVENTS.REQUEST_UPLOAD_LOGS, function (meetingInstance) {
                 // @ts-ignore
-                if (_this10.config.autoUploadLogs) {
+                if (_this11.config.autoUploadLogs) {
                   var _meetingInstance$locu, _meetingInstance$locu2, _meetingInstance$locu3, _meetingInstance$locu4, _meetingInstance$locu5, _meetingInstance$locu6;
-                  _this10.uploadLogs({
+                  _this11.uploadLogs({
                     callStart: meetingInstance === null || meetingInstance === void 0 ? void 0 : (_meetingInstance$locu = meetingInstance.locusInfo) === null || _meetingInstance$locu === void 0 ? void 0 : (_meetingInstance$locu2 = _meetingInstance$locu.fullState) === null || _meetingInstance$locu2 === void 0 ? void 0 : _meetingInstance$locu2.lastActive,
                     locussessionid: meetingInstance === null || meetingInstance === void 0 ? void 0 : (_meetingInstance$locu3 = meetingInstance.locusInfo) === null || _meetingInstance$locu3 === void 0 ? void 0 : (_meetingInstance$locu4 = _meetingInstance$locu3.fullState) === null || _meetingInstance$locu4 === void 0 ? void 0 : _meetingInstance$locu4.sessionId,
                     correlationId: meetingInstance.correlationId,
@@ -1338,7 +1390,7 @@ var Meetings = exports.default = /*#__PURE__*/function (_WebexPlugin) {
             case 29:
               _context3.prev = 29;
               _context3.t0 = _context3["catch"](9);
-              if (!(!(_context3.t0 instanceof _captchaError.default) && !(_context3.t0 instanceof _passwordError.default) && !(_context3.t0 instanceof _permission.default) && !(_context3.t0 instanceof _webinarRegistrationError.default))) {
+              if (!(!(_context3.t0 instanceof _captchaError.default) && !(_context3.t0 instanceof _passwordError.default) && !(_context3.t0 instanceof _permission.default) && !(_context3.t0 instanceof _joinWebinarError.default) && !(_context3.t0 instanceof _joinForbiddenError.default))) {
                 _context3.next = 38;
                 break;
               }
@@ -1428,7 +1480,7 @@ var Meetings = exports.default = /*#__PURE__*/function (_WebexPlugin) {
   }, {
     key: "syncMeetings",
     value: function syncMeetings() {
-      var _this11 = this;
+      var _this12 = this;
       var _ref3 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
         _ref3$keepOnlyLocusMe = _ref3.keepOnlyLocusMeetings,
         keepOnlyLocusMeetings = _ref3$keepOnlyLocusMe === void 0 ? true : _ref3$keepOnlyLocusMe;
@@ -1440,16 +1492,16 @@ var Meetings = exports.default = /*#__PURE__*/function (_WebexPlugin) {
       return this.request.getActiveMeetings().then(function (locusArray) {
         var activeLocusUrl = [];
         if (locusArray !== null && locusArray !== void 0 && locusArray.loci && locusArray.loci.length > 0) {
-          var lociToUpdate = _this11.sortLocusArrayToUpdate(locusArray.loci);
+          var lociToUpdate = _this12.sortLocusArrayToUpdate(locusArray.loci);
           lociToUpdate.forEach(function (locus) {
             activeLocusUrl.push(locus.url);
-            _this11.handleLocusEvent({
+            _this12.handleLocusEvent({
               locus: locus,
               locusUrl: locus.url
             });
           });
         }
-        var meetingsCollection = _this11.meetingCollection.getAll();
+        var meetingsCollection = _this12.meetingCollection.getAll();
         if ((0, _keys.default)(meetingsCollection).length > 0) {
           // Sometimes the mercury events are lost after mercury reconnect
           // Remove any Locus meetings that are not returned by Locus
@@ -1461,7 +1513,7 @@ var Meetings = exports.default = /*#__PURE__*/function (_WebexPlugin) {
             if ((keepOnlyLocusMeetings || locusUrl) && !activeLocusUrl.includes(locusUrl)) {
               // destroy function also uploads logs
               // @ts-ignore
-              _this11.destroy(meeting, _constants.MEETING_REMOVED_REASON.NO_MEETINGS_TO_SYNC);
+              _this12.destroy(meeting, _constants.MEETING_REMOVED_REASON.NO_MEETINGS_TO_SYNC);
             }
           }
         }
@@ -1481,7 +1533,7 @@ var Meetings = exports.default = /*#__PURE__*/function (_WebexPlugin) {
   }, {
     key: "sortLocusArrayToUpdate",
     value: function sortLocusArrayToUpdate(loci) {
-      var _this12 = this;
+      var _this13 = this;
       var mainLoci = loci.filter(function (locus) {
         return !_util2.default.isBreakoutLocusDTO(locus);
       });
@@ -1495,7 +1547,7 @@ var Meetings = exports.default = /*#__PURE__*/function (_WebexPlugin) {
           var _mainLocus$controls, _mainLocus$controls$b, _breakoutLocus$contro, _breakoutLocus$contro2;
           return ((_mainLocus$controls = mainLocus.controls) === null || _mainLocus$controls === void 0 ? void 0 : (_mainLocus$controls$b = _mainLocus$controls.breakout) === null || _mainLocus$controls$b === void 0 ? void 0 : _mainLocus$controls$b.url) === ((_breakoutLocus$contro = breakoutLocus.controls) === null || _breakoutLocus$contro === void 0 ? void 0 : (_breakoutLocus$contro2 = _breakoutLocus$contro.breakout) === null || _breakoutLocus$contro2 === void 0 ? void 0 : _breakoutLocus$contro2.url);
         });
-        var existCorrespondingMeeting = _this12.getCorrespondingMeetingByLocus({
+        var existCorrespondingMeeting = _this13.getCorrespondingMeetingByLocus({
           locus: breakoutLocus,
           locusUrl: breakoutLocus.url
         });
@@ -1503,7 +1555,7 @@ var Meetings = exports.default = /*#__PURE__*/function (_WebexPlugin) {
           // if exists both main session and breakout session locus of the same non-exist meeting, handle main locus first,
           // after meeting create with main locus, then handle the associate breakout locus.
           // if only handle breakout locus, will miss some date
-          _this12.breakoutLocusForHandleLater.push(breakoutLocus);
+          _this13.breakoutLocusForHandleLater.push(breakoutLocus);
         } else {
           lociToUpdate.push(breakoutLocus);
         }