@webex/calling 3.0.0-next.2 → 3.0.0-next.21

package/dist/CallingClient/registration/register.js

@@ -36,11 +36,6 @@ function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len
  */
 var Registration = /*#__PURE__*/function () {
   /**
-   * @param webex - A webex instance.
-   * @param serviceData - indicates whether the backend service is calling or contactcentre
-   * @param mutex - mutex which is used to run any registration scenario exclusively
-   * @param lineEmitter - Line emitter for registration related events
-   * @param logLevel - log level option for registration module
    */
   function Registration(webex, serviceData, mutex, lineEmitter, logLevel) {
     (0, _classCallCheck2.default)(this, Registration);
@@ -71,7 +66,7 @@ var Registration = /*#__PURE__*/function () {
     }
     this.webex = this.sdkConnector.getWebex();
     this.userId = this.webex.internal.device.userId;
-    this.registrationStatus = _types3.MobiusStatus.DEFAULT;
+    this.registrationStatus = _types3.RegistrationStatus.IDLE;
     this.failback429RetryAttempts = 0;
     _Logger.default.setLogger(logLevel, _constants.REGISTRATION_FILE);
     this.rehomingIntervalMin = _constants.DEFAULT_REHOMING_INTERVAL_MIN;
@@ -108,8 +103,6 @@ var Registration = /*#__PURE__*/function () {
     /**
      *  Implementation of sending keepalive.
      *
-     * @param url - Entire device url.
-     * @returns Promise<boolean>.
      */
   }, {
     key: "postKeepAlive",
@@ -139,19 +132,17 @@ var Registration = /*#__PURE__*/function () {
     /**
      * Implementation of delete device.
      *
-     * @param url -.
-     * @param deviceId -.
-     * @param deviceUrl -.
      */
   }, {
     key: "deleteRegistration",
     value: function () {
       var _deleteRegistration = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(url, deviceId, deviceUrl) {
-        var _headers2;
-        var response;
+        var _response;
+        var response, _headers2;
         return _regenerator.default.wrap(function _callee2$(_context2) {
           while (1) switch (_context2.prev = _context2.next) {
             case 0:
+              _context2.prev = 0;
               _context2.t0 = fetch;
               _context2.t1 = "".concat(url).concat(_constants.DEVICES_ENDPOINT_RESOURCE, "/").concat(deviceId);
               _context2.t2 = _types3.HTTP_METHODS.DELETE;
@@ -159,9 +150,9 @@ var Registration = /*#__PURE__*/function () {
               (0, _defineProperty2.default)(_headers2, _constants.CISCO_DEVICE_URL, deviceUrl);
               _context2.t3 = _defineProperty2.default;
               _context2.t4 = _headers2;
-              _context2.next = 9;
+              _context2.next = 10;
               return this.webex.credentials.getUserToken();
-            case 9:
+            case 10:
               _context2.t5 = _context2.sent;
               (0, _context2.t3)(_context2.t4, "Authorization", _context2.t5);
               (0, _defineProperty2.default)(_headers2, "trackingId", "".concat(_constants.WEBEX_WEB_CLIENT, "_").concat((0, _uuid.v4)()));
@@ -171,17 +162,25 @@ var Registration = /*#__PURE__*/function () {
                 method: _context2.t2,
                 headers: _context2.t6
               };
-              _context2.next = 17;
+              _context2.next = 18;
               return (0, _context2.t0)(_context2.t1, _context2.t7);
-            case 17:
+            case 18:
               response = _context2.sent;
+              _context2.next = 24;
+              break;
+            case 21:
+              _context2.prev = 21;
+              _context2.t8 = _context2["catch"](0);
+              _Logger.default.warn("Delete failed with Mobius", {});
+            case 24:
+              this.setStatus(_types3.RegistrationStatus.INACTIVE);
               this.lineEmitter(_types4.LINE_EVENTS.UNREGISTERED);
-              return _context2.abrupt("return", response.json());
-            case 20:
+              return _context2.abrupt("return", (_response = response) === null || _response === void 0 ? void 0 : _response.json());
+            case 27:
             case "end":
               return _context2.stop();
           }
-        }, _callee2, this);
+        }, _callee2, this, [[0, 21]]);
       }));
       function deleteRegistration(_x2, _x3, _x4) {
         return _deleteRegistration.apply(this, arguments);
@@ -191,7 +190,6 @@ var Registration = /*#__PURE__*/function () {
     /**
      * Implementation of POST request for device registration.
      *
-     * @param url - backend service url for registration
      */
   }, {
     key: "postRegistration",
@@ -228,7 +226,6 @@ var Registration = /*#__PURE__*/function () {
     /**
      * Re-attempts registration with the mobius url it was last registered
      * to, that mobius url is expected to be updated already in this.activeMobiusUrl.
-     * @param caller - Caller of this method.
      */
   }, {
     key: "restorePreviousRegistration",
@@ -313,7 +310,6 @@ var Registration = /*#__PURE__*/function () {
      * Calculates and returns a random interval value using input argument
      * attempt as the variable factor.
      *
-     * @param attempt - Number of times registration has been
      *                  attempted already.
      */
   }, {
@@ -329,8 +325,6 @@ var Registration = /*#__PURE__*/function () {
      * Once the time taken since the beginning of retry attempt exceeds the
      * retry threshold, it switches over to backup mobius servers.
      *
-     * @param attempt - Number of times registration has been attempted already.
-     * @param timeElapsed - Time elapsed since the first registration attempt.
      */
   }, {
     key: "startFailoverTimer",
@@ -514,7 +508,6 @@ var Registration = /*#__PURE__*/function () {
     /**
      * Starts failback timer with the interval value received.
      *
-     * @param intervalInSeconds - Failback timer interval value in seconds.
      */
   }, {
     key: "startFailbackTimer",
@@ -633,7 +626,6 @@ var Registration = /*#__PURE__*/function () {
      * if received in registration response from a primary mobius
      * server.
      *
-     * @param deviceInfo - Line info.
      */
   }, {
     key: "setIntervalValues",
@@ -643,6 +635,11 @@ var Registration = /*#__PURE__*/function () {
         this.rehomingIntervalMax = deviceInfo !== null && deviceInfo !== void 0 && deviceInfo.rehomingIntervalMax ? deviceInfo.rehomingIntervalMax : _constants.DEFAULT_REHOMING_INTERVAL_MAX;
       }
     }
+
+    /**
+     * Retrieves information about the device as {@link IDeviceInfo}.
+     *
+     */
   }, {
     key: "getDeviceInfo",
     value: function getDeviceInfo() {
@@ -650,16 +647,15 @@ var Registration = /*#__PURE__*/function () {
     }
 
     /**
-     * .
+     * Checks if the device is currently registered.
      *
-     * @returns True if this device is in registered state
      *          by checking if isRegistered state is set to
      *          ACTIVE, else false.
      */
   }, {
     key: "isDeviceRegistered",
     value: function isDeviceRegistered() {
-      return this.registrationStatus === _types3.MobiusStatus.ACTIVE;
+      return this.registrationStatus === _types3.RegistrationStatus.ACTIVE;
     }
   }, {
     key: "getStatus",
@@ -676,7 +672,6 @@ var Registration = /*#__PURE__*/function () {
      * Start fresh registration cycle with the mobius
      * server list already present.
      *
-     * @param caller - Caller of this method.
      */
   }, {
     key: "restartRegistration",
@@ -713,6 +708,11 @@ var Registration = /*#__PURE__*/function () {
       }
       return restartRegistration;
     }()
+    /**
+     * Restores the connection and attempts refreshing existing registration with server.
+     * Allows retry if not restored in the first attempt.
+     *
+     */
   }, {
     key: "handleConnectionRestoration",
     value: function () {
@@ -731,7 +731,7 @@ var Registration = /*#__PURE__*/function () {
                         _context15.next = 14;
                         break;
                       }
-                      _Logger.default.info('Mercury connection is up again, Re-registering with Mobius', {
+                      _Logger.default.info('Mercury connection is up again, re-registering with Webex Calling if needed', {
                         file: _constants.REGISTRATION_FILE,
                         method: _this4.handleConnectionRestoration.name
                       });
@@ -882,9 +882,6 @@ var Registration = /*#__PURE__*/function () {
      * argument one by one until registration either succeeds with
      * one or all of them are tried.
      *
-     * @param caller - Caller of this method.
-     * @param servers - List of mobius server urls to try.
-     * @returns Promise resolving to a boolean carrying true if registration
      *          attempt has hit a final error and a retry should not be scheduled
      *          else false.
      */
@@ -923,13 +920,13 @@ var Registration = /*#__PURE__*/function () {
               _iterator.s();
             case 8:
               if ((_step = _iterator.n()).done) {
-                _context19.next = 52;
+                _context19.next = 53;
                 break;
               }
               url = _step.value;
               _context19.prev = 10;
               abort = false;
-              this.registrationStatus = _types3.MobiusStatus.DEFAULT;
+              this.registrationStatus = _types3.RegistrationStatus.INACTIVE;
               this.lineEmitter(_types4.LINE_EVENTS.CONNECTING);
               _Logger.default.log("[".concat(caller, "] : Mobius url to contact: ").concat(url), {
                 file: _constants.REGISTRATION_FILE,
@@ -942,14 +939,14 @@ var Registration = /*#__PURE__*/function () {
               resp = _context19.sent;
               this.deviceInfo = resp.body;
               this.lineEmitter(_types4.LINE_EVENTS.REGISTERED, resp.body);
-              this.registrationStatus = _types3.MobiusStatus.ACTIVE;
+              this.registrationStatus = _types3.RegistrationStatus.ACTIVE;
               this.setActiveMobiusUrl(url);
               this.setIntervalValues(this.deviceInfo);
               this.metricManager.setDeviceInfo(this.deviceInfo);
               this.metricManager.submitRegistrationMetric(_types2.METRIC_EVENT.REGISTRATION, _types2.REG_ACTION.REGISTER, _types2.METRIC_TYPE.BEHAVIORAL, undefined);
               this.startKeepaliveTimer((_this$deviceInfo$devi = this.deviceInfo.device) === null || _this$deviceInfo$devi === void 0 ? void 0 : _this$deviceInfo$devi.uri, this.deviceInfo.keepaliveInterval);
               this.initiateFailback();
-              return _context19.abrupt("break", 52);
+              return _context19.abrupt("break", 53);
             case 30:
               _context19.prev = 30;
               _context19.t0 = _context19["catch"](10);
@@ -968,7 +965,7 @@ var Registration = /*#__PURE__*/function () {
               }, this.restoreRegistrationCallBack());
             case 35:
               abort = _context19.sent;
-              if (!(this.registrationStatus === _types3.MobiusStatus.ACTIVE)) {
+              if (!(this.registrationStatus === _types3.RegistrationStatus.ACTIVE)) {
                 _context19.next = 39;
                 break;
               }
@@ -976,49 +973,50 @@ var Registration = /*#__PURE__*/function () {
                 file: _constants.REGISTRATION_FILE,
                 method: this.attemptRegistrationWithServers.name
               });
-              return _context19.abrupt("break", 52);
+              return _context19.abrupt("break", 53);
             case 39:
               if (!abort) {
-                _context19.next = 43;
+                _context19.next = 44;
                 break;
               }
-              return _context19.abrupt("break", 52);
-            case 43:
+              this.setStatus(_types3.RegistrationStatus.INACTIVE);
+              return _context19.abrupt("break", 53);
+            case 44:
               if (!(caller === this.executeFailback.name)) {
-                _context19.next = 50;
+                _context19.next = 51;
                 break;
               }
               error = body.statusCode;
               if (!(error === _types.ERROR_CODE.TOO_MANY_REQUESTS)) {
-                _context19.next = 50;
+                _context19.next = 51;
                 break;
               }
-              _context19.next = 48;
+              _context19.next = 49;
               return this.scheduleFailback429Retry();
-            case 48:
+            case 49:
               abort = true;
-              return _context19.abrupt("break", 52);
-            case 50:
+              return _context19.abrupt("break", 53);
+            case 51:
               _context19.next = 8;
               break;
-            case 52:
-              _context19.next = 57;
+            case 53:
+              _context19.next = 58;
               break;
-            case 54:
-              _context19.prev = 54;
+            case 55:
+              _context19.prev = 55;
               _context19.t1 = _context19["catch"](6);
               _iterator.e(_context19.t1);
-            case 57:
-              _context19.prev = 57;
+            case 58:
+              _context19.prev = 58;
               _iterator.f();
-              return _context19.finish(57);
-            case 60:
-              return _context19.abrupt("return", abort);
+              return _context19.finish(58);
             case 61:
+              return _context19.abrupt("return", abort);
+            case 62:
             case "end":
               return _context19.stop();
           }
-        }, _callee19, this, [[6, 54, 57, 60], [10, 30]]);
+        }, _callee19, this, [[6, 55, 58, 61], [10, 30]]);
       }));
       function attemptRegistrationWithServers(_x11) {
         return _attemptRegistrationWithServers.apply(this, arguments);
@@ -1028,11 +1026,6 @@ var Registration = /*#__PURE__*/function () {
     /**
      * This method sets up a timer to periodically send keep-alive requests to maintain a connection.
      * It handles retries, error handling, and re-registration attempts based on the response, ensuring continuous connectivity with the server.
-     * @param keepAliveRetryCount
-     * @param url
-     * @param logContext
-     * @param interval
-     * @returns
      */
   }, {
     key: "startKeepaliveTimer",
@@ -1093,7 +1086,7 @@ var Registration = /*#__PURE__*/function () {
                         _context20.next = 28;
                         break;
                       }
-                      _this7.setStatus(_types3.MobiusStatus.DEFAULT);
+                      _this7.setStatus(_types3.RegistrationStatus.INACTIVE);
                       _this7.clearKeepaliveTimer();
                       _this7.clearFailbackTimer();
                       _this7.lineEmitter(_types4.LINE_EVENTS.UNREGISTERED);
@@ -1158,7 +1151,7 @@ var Registration = /*#__PURE__*/function () {
               _Logger.default.warn("Delete failed with Mobius", {});
             case 8:
               this.clearKeepaliveTimer();
-              this.setStatus(_types3.MobiusStatus.DEFAULT);
+              this.setStatus(_types3.RegistrationStatus.INACTIVE);
             case 10:
             case "end":
               return _context22.stop();
@@ -1171,7 +1164,6 @@ var Registration = /*#__PURE__*/function () {
       return deregister;
     }()
     /**
-     * @returns The value of instance variable registerRetry.
      *          Indicates whether the calling client is in a mode
      *          to retry registration.
      */
@@ -1185,7 +1177,6 @@ var Registration = /*#__PURE__*/function () {
      * Sets the received value in instance variable
      * registerRetry for registration retry cases.
      *
-     * @param value - for registerRetry
      */
   }, {
     key: "setRegRetry",
@@ -1196,9 +1187,6 @@ var Registration = /*#__PURE__*/function () {
     /**
      * Restores the deviceInfo object in callingClient when receiving a 403 with error code 101.
      *
-     * @param callingClient - Instance of CallingClient.
-     * @param restoreData - Data from Mobius with existing device information.
-     * @returns Boolean.
      */
   }, {
     key: "getExistingDevice",
@@ -1214,7 +1202,7 @@ var Registration = /*#__PURE__*/function () {
         var stringToReplace = "".concat(_constants.DEVICES_ENDPOINT_RESOURCE, "/").concat(restoreData.devices[0].deviceId);
         var uri = restoreData.devices[0].uri.replace(stringToReplace, '');
         this.setActiveMobiusUrl(uri);
-        this.registrationStatus = _types3.MobiusStatus.ACTIVE;
+        this.registrationStatus = _types3.RegistrationStatus.ACTIVE;
         return true;
       }
       return false;
@@ -1228,7 +1216,6 @@ var Registration = /*#__PURE__*/function () {
      * invoked again on receiving all calls cleared event from
      * callManager.
      *
-     * @param caller - Caller of this method.
      */
   }, {
     key: "reconnectOnFailure",
@@ -1280,12 +1267,7 @@ var Registration = /*#__PURE__*/function () {
   }]);
   return Registration;
 }();
-/**
- * @param webex - A webex instance.
- * @param serviceData - indicates whether the backend service is calling or contactcentre
- * @param mutex - mutex which is used to run any registration scenario exclusively
- * @param lineEmitter - Line emitter for registration related events
- * @param logLevel - log level option for registration module
+/*
  */
 exports.Registration = Registration;
 var createRegistration = function createRegistration(webex, serviceData, mutex, lineEmitter, logLevel) {