@atlaskit/collab-provider 8.3.0 → 8.4.0

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @atlaskit/collab-provider
 
+## 8.4.0
+
+### Minor Changes
+
+- [`eae755e434a`](https://bitbucket.org/atlassian/atlassian-frontend/commits/eae755e434a) - [ESS-3269] Don't return an empty document if something goes wrong when returning the final acknowledge state from the collab provider
+- [`ca548613b49`](https://bitbucket.org/atlassian/atlassian-frontend/commits/ca548613b49) - ESS-3218 Add new configuration option throwOnNotConnected, which will throw not connected errors when attempting to save data whilst client is offline.
+- [`329d3bb4e05`](https://bitbucket.org/atlassian/atlassian-frontend/commits/329d3bb4e05) - ESS-2962: added canCache flag in Config for Collab-provider. Channel now stores token locally if canCache flag is passed. Uses local token for reconnections if connection is lost for errors other that 401 and 403.
+- [`1b9c38c7f48`](https://bitbucket.org/atlassian/atlassian-frontend/commits/1b9c38c7f48) - [ESS-3269] Added error handling and metrics for retrieving the current state
+
+### Patch Changes
+
+- [`2a076027203`](https://bitbucket.org/atlassian/atlassian-frontend/commits/2a076027203) - NO-ISSUE fix the permission error on permissionTokenRefresh
+- [`bde10feab09`](https://bitbucket.org/atlassian/atlassian-frontend/commits/bde10feab09) - Avoid using callbacks when initialising socket connection
+- [`f9a6a671d14`](https://bitbucket.org/atlassian/atlassian-frontend/commits/f9a6a671d14) - add comment to indicate that disconnect handler will be called when Firefox reload
+- Updated dependencies
+
 ## 8.3.0
 
 ### Minor Changes

package/dist/cjs/analytics/index.js

@@ -67,7 +67,8 @@ var AnalyticsHelper = /*#__PURE__*/function () {
         eventAction: _const.EVENT_ACTION.ERROR,
         attributes: {
           documentAri: this.documentAri,
-          errorMessage: errorMessage
+          errorMessage: errorMessage,
+          errorName: error instanceof Error ? error.name : undefined
         },
         nonPrivacySafeAttributes: {
           error: error

package/dist/cjs/analytics/performance.js

@@ -13,6 +13,7 @@ exports.MEASURE_NAME = MEASURE_NAME;
   MEASURE_NAME["DOCUMENT_INIT"] = "documentInit";
   MEASURE_NAME["COMMIT_UNCONFIRMED_STEPS"] = "commitUnconfirmedSteps";
   MEASURE_NAME["PUBLISH_PAGE"] = "publishPage";
+  MEASURE_NAME["GET_CURRENT_STATE"] = "getCurrentState";
 })(MEASURE_NAME || (exports.MEASURE_NAME = MEASURE_NAME = {}));
 var isPerformanceAPIAvailable = function isPerformanceAPIAvailable() {
   return typeof window !== 'undefined' && 'performance' in window && ['measure', 'clearMeasures', 'clearMarks', 'getEntriesByName', 'getEntriesByType'].every(function (api) {

package/dist/cjs/channel.js

@@ -16,13 +16,15 @@ var _getPrototypeOf2 = _interopRequireDefault(require("@babel/runtime/helpers/ge
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _utilServiceSupport = require("@atlaskit/util-service-support");
 var _emitter = require("./emitter");
-var _errorCodeMapper = require("./error-code-mapper");
+var _errorCodeMapper = require("./errors/error-code-mapper");
 var _utils = require("./helpers/utils");
 var _performance = require("./analytics/performance");
 var _const = require("./helpers/const");
 var _reconnectHelper = _interopRequireDefault(require("./connectivity/reconnect-helper"));
 var _ufo = require("./analytics/ufo");
+var _disconnectedReasonMapper = require("./disconnected-reason-mapper");
 var _network = _interopRequireDefault(require("./connectivity/network"));
+var _errorTypes = require("./errors/error-types");
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
 function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = (0, _getPrototypeOf2.default)(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = (0, _getPrototypeOf2.default)(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return (0, _possibleConstructorReturn2.default)(this, result); }; }
@@ -49,32 +51,63 @@ var Channel = /*#__PURE__*/function (_Emitter) {
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "getSocket", function () {
       return _this.socket;
     });
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "getToken", function () {
+      return _this.token;
+    });
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "setToken", function (value) {
+      if (_this.config.cacheToken) {
+        _this.token = value;
+      }
+    });
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "unsetToken", function () {
+      return _this.setToken();
+    });
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "handlePermissionInvalidateToken", function (data) {
+      var _this$analyticsHelper;
+      logger('Received permission invalidate event ', data);
+      (_this$analyticsHelper = _this.analyticsHelper) === null || _this$analyticsHelper === void 0 ? void 0 : _this$analyticsHelper.sendActionEvent(_const.EVENT_ACTION.INVALIDATE_TOKEN, _const.EVENT_STATUS.SUCCESS, {
+        reason: data.reason,
+        // Potentially incorrect when value of token changes between connecting and connect.
+        // See: https://bitbucket.org/atlassian/%7Bc8e2f021-38d2-46d0-9b7a-b3f7b428f724%7D/pull-requests/29905#comment-375308874
+        usedCachedToken: _this.token ? true : false
+      });
+      _this.unsetToken();
+    });
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "onConnectError", function (error) {
-      var _this$analyticsHelper, _this$analyticsHelper2;
+      var _this$analyticsHelper2, _this$analyticsHelper3;
       var measure = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.SOCKET_CONNECT, _this.analyticsHelper);
-      (_this$analyticsHelper = _this.analyticsHelper) === null || _this$analyticsHelper === void 0 ? void 0 : _this$analyticsHelper.sendActionEvent(_const.EVENT_ACTION.CONNECTION, _const.EVENT_STATUS.FAILURE, {
-        latency: measure === null || measure === void 0 ? void 0 : measure.duration
+      (_this$analyticsHelper2 = _this.analyticsHelper) === null || _this$analyticsHelper2 === void 0 ? void 0 : _this$analyticsHelper2.sendActionEvent(_const.EVENT_ACTION.CONNECTION, _const.EVENT_STATUS.FAILURE, {
+        latency: measure === null || measure === void 0 ? void 0 : measure.duration,
+        // Potentially incorrect when value of token changes between connecting and connect.
+        // See: https://bitbucket.org/atlassian/%7Bc8e2f021-38d2-46d0-9b7a-b3f7b428f724%7D/pull-requests/29905#comment-375308874
+        usedCachedToken: _this.token ? true : false
       });
-      (_this$analyticsHelper2 = _this.analyticsHelper) === null || _this$analyticsHelper2 === void 0 ? void 0 : _this$analyticsHelper2.sendErrorEvent(error, 'Error while establishing connection');
+      (_this$analyticsHelper3 = _this.analyticsHelper) === null || _this$analyticsHelper3 === void 0 ? void 0 : _this$analyticsHelper3.sendErrorEvent(error, 'Error while establishing connection');
       // If error received with `data`, it means the connection is rejected
       // by the server on purpose for example no permission, so no need to
       // keep the underneath connection, need to close. But some error like
       // `xhr polling error` needs to retry.
-      if (!!error.data) {
+      var errorData = error.data;
+      if (errorData) {
         var _this$socket;
+        // We only want to refresh the token if only its invalid
+        if ([401, 403].includes(errorData.status)) {
+          //nullify token so it is forced to generate new token on reconnect
+          _this.unsetToken();
+        }
         (_this$socket = _this.socket) === null || _this$socket === void 0 ? void 0 : _this$socket.close();
       }
       _this.emit('error', {
         message: error.message,
-        data: error.data
+        data: errorData
       });
     });
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "onReconnectError", function (error) {
       var _this$reconnectHelper, _this$reconnectHelper2;
       (_this$reconnectHelper = _this.reconnectHelper) === null || _this$reconnectHelper === void 0 ? void 0 : _this$reconnectHelper.countReconnectError();
       if ((_this$reconnectHelper2 = _this.reconnectHelper) !== null && _this$reconnectHelper2 !== void 0 && _this$reconnectHelper2.isLikelyNetworkIssue()) {
-        var _this$analyticsHelper3;
-        (_this$analyticsHelper3 = _this.analyticsHelper) === null || _this$analyticsHelper3 === void 0 ? void 0 : _this$analyticsHelper3.sendErrorEvent(error, 'Likely network issue while reconnecting the channel');
+        var _this$analyticsHelper4;
+        (_this$analyticsHelper4 = _this.analyticsHelper) === null || _this$analyticsHelper4 === void 0 ? void 0 : _this$analyticsHelper4.sendErrorEvent(error, 'Likely network issue while reconnecting the channel');
         _this.emit('error', {
           message: 'Reconnection failed 8 times when browser was offline, likely there was a network issue.',
           data: {
@@ -85,12 +118,15 @@ var Channel = /*#__PURE__*/function (_Emitter) {
       }
     });
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "onConnect", function () {
-      var _this$analyticsHelper4;
+      var _this$analyticsHelper5;
       _this.connected = true;
       logger('Connected.', _this.socket.id);
       var measure = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.SOCKET_CONNECT, _this.analyticsHelper);
-      (_this$analyticsHelper4 = _this.analyticsHelper) === null || _this$analyticsHelper4 === void 0 ? void 0 : _this$analyticsHelper4.sendActionEvent(_const.EVENT_ACTION.CONNECTION, _const.EVENT_STATUS.SUCCESS, {
-        latency: measure === null || measure === void 0 ? void 0 : measure.duration
+      (_this$analyticsHelper5 = _this.analyticsHelper) === null || _this$analyticsHelper5 === void 0 ? void 0 : _this$analyticsHelper5.sendActionEvent(_const.EVENT_ACTION.CONNECTION, _const.EVENT_STATUS.SUCCESS, {
+        latency: measure === null || measure === void 0 ? void 0 : measure.duration,
+        // Potentially incorrect when value of token changes between connecting and connect.
+        // See: https://bitbucket.org/atlassian/%7Bc8e2f021-38d2-46d0-9b7a-b3f7b428f724%7D/pull-requests/29905#comment-375308874
+        usedCachedToken: _this.token ? true : false
       });
       _this.emit('connected', {
         sid: _this.socket.id,
@@ -102,10 +138,10 @@ var Channel = /*#__PURE__*/function (_Emitter) {
       logger('Session ID is', _this.socket.id);
       if (data.type === 'initial') {
         if (!_this.initialized) {
-          var _this$initExperience, _this$analyticsHelper5;
+          var _this$initExperience, _this$analyticsHelper6;
           var measure = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.DOCUMENT_INIT, _this.analyticsHelper);
           (_this$initExperience = _this.initExperience) === null || _this$initExperience === void 0 ? void 0 : _this$initExperience.success();
-          (_this$analyticsHelper5 = _this.analyticsHelper) === null || _this$analyticsHelper5 === void 0 ? void 0 : _this$analyticsHelper5.sendActionEvent(_const.EVENT_ACTION.DOCUMENT_INIT,
+          (_this$analyticsHelper6 = _this.analyticsHelper) === null || _this$analyticsHelper6 === void 0 ? void 0 : _this$analyticsHelper6.sendActionEvent(_const.EVENT_ACTION.DOCUMENT_INIT,
           // TODO: detect when document init fails and fire corresponding event for it
           _const.EVENT_STATUS.SUCCESS, {
             latency: measure === null || measure === void 0 ? void 0 : measure.duration,
@@ -173,34 +209,76 @@ var Channel = /*#__PURE__*/function (_Emitter) {
         documentAri = _this$config.documentAri,
         url = _this$config.url;
       var createSocket = this.config.createSocket;
-      var permissionTokenRefresh = this.config.permissionTokenRefresh;
-      var authCb = null;
+      var _this$config2 = this.config,
+        permissionTokenRefresh = _this$config2.permissionTokenRefresh,
+        cacheToken = _this$config2.cacheToken;
+      var auth;
+      var authData = {
+        // The initialized status. If false, BE will send document, otherwise not.
+        initialized: this.initialized,
+        // ESS-1009 Allow to opt-in into 404 response
+        need404: this.config.need404
+      };
       if (permissionTokenRefresh) {
-        authCb = function authCb(cb) {
-          permissionTokenRefresh().then(function (token) {
-            cb(_objectSpread(_objectSpread({}, token ? {
-              token: token
-            } : {}), {}, {
-              // The initialized status. If false, BE will send document, otherwise not.
-              initialized: _this2.initialized,
-              // ESS-1009 Allow to opt-in into 404 response
-              need404: _this2.config.need404
-            }));
-          }).catch(function (err) {
-            _this2.emit('error', err);
-          });
-        };
+        auth = /*#__PURE__*/function () {
+          var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(cb) {
+            var token, newErr;
+            return _regenerator.default.wrap(function _callee$(_context) {
+              while (1) {
+                switch (_context.prev = _context.next) {
+                  case 0:
+                    if (!(cacheToken && _this2.token)) {
+                      _context.next = 5;
+                      break;
+                    }
+                    authData.token = _this2.token;
+                    cb(authData);
+                    _context.next = 17;
+                    break;
+                  case 5:
+                    _context.prev = 5;
+                    _context.next = 8;
+                    return permissionTokenRefresh();
+                  case 8:
+                    token = _context.sent;
+                    if (token) {
+                      // save token locally
+                      _this2.setToken(token);
+                      authData.token = token;
+                    }
+                    cb(authData);
+                    _context.next = 17;
+                    break;
+                  case 13:
+                    _context.prev = 13;
+                    _context.t0 = _context["catch"](5);
+                    newErr = {
+                      message: _context.t0.message ? _context.t0.message : 'Content not found',
+                      data: {
+                        status: 403,
+                        code: _context.t0.data.code ? _context.t0.data.code : 'INSUFFICIENT_EDITING_PERMISSION',
+                        meta: {
+                          description: _context.t0.data.meta.description ? _context.t0.data.meta.description : 'RESOURCE_DELETED',
+                          reason: _context.t0.data.meta.reason ? _context.t0.data.meta.reason : 'RESOURCE_DELETED'
+                        }
+                      }
+                    };
+                    _this2.emit('error', newErr);
+                  case 17:
+                  case "end":
+                    return _context.stop();
+                }
+              }
+            }, _callee, null, [[5, 13]]);
+          }));
+          return function auth(_x) {
+            return _ref.apply(this, arguments);
+          };
+        }();
       } else {
-        authCb = function authCb(cb) {
-          cb({
-            // The initialized status. If false, BE will send document, otherwise not.
-            initialized: _this2.initialized,
-            // ESS-1009 Allow to opt-in into 404 response
-            need404: _this2.config.need404
-          });
-        };
+        auth = authData;
       }
-      this.socket = createSocket("".concat(url, "/session/").concat(documentAri), authCb, this.config.productInfo);
+      this.socket = createSocket("".concat(url, "/session/").concat(documentAri), auth, this.config.productInfo);
 
       // Due to https://github.com/socketio/socket.io-client/issues/1473,
       // reconnect no longer fired on the socket.
@@ -222,11 +300,11 @@ var Channel = /*#__PURE__*/function (_Emitter) {
       this.socket.on('participant:left', function (data) {
         _this2.emit('participant:left', data);
       });
-      this.socket.on('participant:updated', function (_ref) {
-        var sessionId = _ref.sessionId,
-          timestamp = _ref.timestamp,
-          data = _ref.data,
-          clientId = _ref.clientId;
+      this.socket.on('participant:updated', function (_ref2) {
+        var sessionId = _ref2.sessionId,
+          timestamp = _ref2.timestamp,
+          data = _ref2.data,
+          clientId = _ref2.clientId;
         _this2.emit('participant:updated', _objectSpread({
           sessionId: sessionId,
           timestamp: timestamp,
@@ -242,18 +320,18 @@ var Channel = /*#__PURE__*/function (_Emitter) {
         _this2.emit('status', data);
       });
       this.socket.on('disconnect', /*#__PURE__*/function () {
-        var _ref2 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(reason) {
+        var _ref3 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(reason) {
           var _this2$analyticsHelpe;
-          return _regenerator.default.wrap(function _callee$(_context) {
+          return _regenerator.default.wrap(function _callee2$(_context2) {
             while (1) {
-              switch (_context.prev = _context.next) {
+              switch (_context2.prev = _context2.next) {
                 case 0:
                   _this2.connected = false;
                   logger("disconnect reason: ".concat(reason));
                   _this2.emit('disconnect', {
                     reason: reason
                   });
-                  if (reason === 'io server disconnect' && _this2.socket) {
+                  if (reason === _disconnectedReasonMapper.socketIOReasons.IO_SERVER_DISCONNECT && _this2.socket) {
                     // The disconnection was initiated by the server, we need to reconnect manually.
                     try {
                       _this2.socket.connect();
@@ -270,13 +348,13 @@ var Channel = /*#__PURE__*/function (_Emitter) {
                   }
                 case 4:
                 case "end":
-                  return _context.stop();
+                  return _context2.stop();
               }
             }
-          }, _callee);
+          }, _callee2);
         }));
-        return function (_x) {
-          return _ref2.apply(this, arguments);
+        return function (_x2) {
+          return _ref3.apply(this, arguments);
         };
       }());
 
@@ -288,6 +366,7 @@ var Channel = /*#__PURE__*/function (_Emitter) {
       // `connect_error`'s parameter type is `Error`.
       // Ensure the error emit to the provider has the same structure, so we can handle them unified.
       this.socket.on('connect_error', this.onConnectError);
+      this.socket.on('permission:invalidateToken', this.handlePermissionInvalidateToken);
 
       // To trigger reconnection when browser comes back online
       if (!this.network) {
@@ -304,121 +383,139 @@ var Channel = /*#__PURE__*/function (_Emitter) {
   }, {
     key: "fetchCatchup",
     value: function () {
-      var _fetchCatchup = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(fromVersion) {
-        var _yield$this$config$pe, _yield$utils$requestS, doc, version, stepMaps, metadata, errorNotFound, errorCatchup;
-        return _regenerator.default.wrap(function _callee2$(_context2) {
+      var _fetchCatchup = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3(fromVersion) {
+        var _this3 = this;
+        var _ref4, _this$token, _yield$utils$requestS, doc, version, stepMaps, metadata, errorNotFound, errorCatchup;
+        return _regenerator.default.wrap(function _callee3$(_context3) {
           while (1) {
-            switch (_context2.prev = _context2.next) {
+            switch (_context3.prev = _context3.next) {
               case 0:
-                _context2.prev = 0;
-                _context2.t0 = _utilServiceSupport.utils;
-                _context2.t1 = this.config;
-                _context2.t2 = "document/".concat(encodeURIComponent(this.config.documentAri), "/catchup");
-                _context2.t3 = {
+                _context3.prev = 0;
+                _context3.t0 = _utilServiceSupport.utils;
+                _context3.t1 = this.config;
+                _context3.t2 = "document/".concat(encodeURIComponent(this.config.documentAri), "/catchup");
+                _context3.t3 = {
                   version: fromVersion
                 };
-                _context2.t4 = _objectSpread;
-                _context2.t5 = _objectSpread;
-                _context2.t6 = {};
+                _context3.t4 = _objectSpread;
+                _context3.t5 = _objectSpread;
+                _context3.t6 = {};
                 if (!this.config.permissionTokenRefresh) {
-                  _context2.next = 24;
+                  _context3.next = 29;
                   break;
                 }
-                _context2.next = 11;
-                return this.config.permissionTokenRefresh();
-              case 11:
-                _context2.t9 = _yield$this$config$pe = _context2.sent;
-                _context2.t8 = _context2.t9 !== null;
-                if (!_context2.t8) {
-                  _context2.next = 15;
+                if (!((_this$token = this.token) !== null && _this$token !== void 0)) {
+                  _context3.next = 13;
                   break;
                 }
-                _context2.t8 = _yield$this$config$pe !== void 0;
+                _context3.t9 = _this$token;
+                _context3.next = 16;
+                break;
+              case 13:
+                _context3.next = 15;
+                return this.config.permissionTokenRefresh().then(function (token) {
+                  if (token) {
+                    _this3.setToken(token);
+                  }
+                  return token;
+                });
               case 15:
-                if (!_context2.t8) {
-                  _context2.next = 19;
+                _context3.t9 = _context3.sent;
+              case 16:
+                _context3.t10 = _ref4 = _context3.t9;
+                _context3.t8 = _context3.t10 !== null;
+                if (!_context3.t8) {
+                  _context3.next = 20;
                   break;
                 }
-                _context2.t10 = _yield$this$config$pe;
-                _context2.next = 20;
-                break;
-              case 19:
-                _context2.t10 = undefined;
+                _context3.t8 = _ref4 !== void 0;
               case 20:
-                _context2.t11 = _context2.t10;
-                _context2.t7 = {
-                  'x-token': _context2.t11
-                };
-                _context2.next = 25;
+                if (!_context3.t8) {
+                  _context3.next = 24;
+                  break;
+                }
+                _context3.t11 = _ref4;
+                _context3.next = 25;
                 break;
               case 24:
-                _context2.t7 = {};
+                _context3.t11 = undefined;
               case 25:
-                _context2.t12 = _context2.t7;
-                _context2.t13 = (0, _context2.t5)(_context2.t6, _context2.t12);
-                _context2.t14 = {};
-                _context2.t15 = {
+                _context3.t12 = _context3.t11;
+                _context3.t7 = {
+                  'x-token': _context3.t12
+                };
+                _context3.next = 30;
+                break;
+              case 29:
+                _context3.t7 = {};
+              case 30:
+                _context3.t13 = _context3.t7;
+                _context3.t14 = (0, _context3.t5)(_context3.t6, _context3.t13);
+                _context3.t15 = {};
+                _context3.t16 = {
                   'x-product': (0, _utils.getProduct)(this.config.productInfo),
                   'x-subproduct': (0, _utils.getSubProduct)(this.config.productInfo)
                 };
-                _context2.t16 = (0, _context2.t4)(_context2.t13, _context2.t14, _context2.t15);
-                _context2.t17 = {
-                  headers: _context2.t16
+                _context3.t17 = (0, _context3.t4)(_context3.t14, _context3.t15, _context3.t16);
+                _context3.t18 = {
+                  headers: _context3.t17
                 };
-                _context2.t18 = {
-                  path: _context2.t2,
-                  queryParams: _context2.t3,
-                  requestInit: _context2.t17
+                _context3.t19 = {
+                  path: _context3.t2,
+                  queryParams: _context3.t3,
+                  requestInit: _context3.t18
                 };
-                _context2.next = 34;
-                return _context2.t0.requestService.call(_context2.t0, _context2.t1, _context2.t18);
-              case 34:
-                _yield$utils$requestS = _context2.sent;
+                _context3.next = 39;
+                return _context3.t0.requestService.call(_context3.t0, _context3.t1, _context3.t19);
+              case 39:
+                _yield$utils$requestS = _context3.sent;
                 doc = _yield$utils$requestS.doc;
                 version = _yield$utils$requestS.version;
                 stepMaps = _yield$utils$requestS.stepMaps;
                 metadata = _yield$utils$requestS.metadata;
-                return _context2.abrupt("return", {
+                return _context3.abrupt("return", {
                   doc: doc,
                   version: version,
                   stepMaps: stepMaps,
                   metadata: metadata
                 });
-              case 42:
-                _context2.prev = 42;
-                _context2.t19 = _context2["catch"](0);
-                if (!(_context2.t19.code === 404)) {
-                  _context2.next = 48;
+              case 47:
+                _context3.prev = 47;
+                _context3.t20 = _context3["catch"](0);
+                if (!(_context3.t20.code === 404)) {
+                  _context3.next = 53;
                   break;
                 }
                 errorNotFound = {
                   message: _errorCodeMapper.ErrorCodeMapper.documentNotFound.message,
                   data: {
-                    status: _context2.t19.code,
+                    status: _context3.t20.code,
                     code: _errorCodeMapper.ErrorCodeMapper.documentNotFound.code
                   }
                 };
                 this.emit('error', errorNotFound);
-                return _context2.abrupt("return", {});
-              case 48:
-                logger("Can't fetch the catchup", _context2.t19.message);
+                return _context3.abrupt("return", {});
+              case 53:
+                //nullify token so it is forced to generate new token on reconnect
+                this.unsetToken();
+                logger("Can't fetch the catchup", _context3.t20.message);
                 errorCatchup = {
                   message: _errorCodeMapper.ErrorCodeMapper.catchupFail.message,
                   data: {
-                    status: _context2.t19.status,
+                    status: _context3.t20.status,
                     code: _errorCodeMapper.ErrorCodeMapper.catchupFail.code
                   }
                 };
                 this.emit('error', errorCatchup);
-                throw _context2.t19;
-              case 52:
+                throw _context3.t20;
+              case 58:
               case "end":
-                return _context2.stop();
+                return _context3.stop();
             }
           }
-        }, _callee2, this, [[0, 42]]);
+        }, _callee3, this, [[0, 47]]);
       }));
-      function fetchCatchup(_x2) {
+      function fetchCatchup(_x3) {
         return _fetchCatchup.apply(this, arguments);
       }
       return fetchCatchup;
@@ -429,7 +526,13 @@ var Channel = /*#__PURE__*/function (_Emitter) {
   }, {
     key: "broadcast",
     value: function broadcast(type, data, callback) {
-      if (!this.connected || !this.socket) {
+      if (!this.socket) {
+        throw new _errorTypes.NotInitializedError('Cannot broadcast, not initialized yet');
+      }
+      if (!this.connected) {
+        if (this.config.throwOnNotConnected) {
+          throw new _errorTypes.NotConnectedError('Cannot broadcast, currently offline.');
+        }
         return;
       }
       this.socket.emit('broadcast', _objectSpread({
@@ -439,8 +542,13 @@ var Channel = /*#__PURE__*/function (_Emitter) {
   }, {
     key: "sendMetadata",
     value: function sendMetadata(metadata) {
-      if (!this.connected || !this.socket) {
-        return;
+      if (!this.socket) {
+        throw new _errorTypes.NotInitializedError('Cannot send metadata, not initialized yet');
+      }
+      if (!this.connected) {
+        if (this.config.throwOnNotConnected) {
+          throw new _errorTypes.NotConnectedError('Cannot send metadata, currently offline.');
+        }
       }
       this.socket.emit('metadata', metadata);
     }
@@ -459,6 +567,8 @@ var Channel = /*#__PURE__*/function (_Emitter) {
       this.unsubscribeAll();
       (_this$network = this.network) === null || _this$network === void 0 ? void 0 : _this$network.destroy();
       this.network = null;
+      //nullify token so it is forced to generate new token on reconnect
+      this.unsetToken();
       if (this.socket) {
         var _this$reconnectHelper3;
         this.socket.close();

package/dist/cjs/{error-code-mapper.js → errors/error-code-mapper.js}

@@ -9,7 +9,7 @@ var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
 var ErrorCodeMapper = {
   noPermissionError: {
     code: 'NO_PERMISSION_ERROR',
-    message: 'User does not have permissions to access this document'
+    message: 'User does not have permissions to access this document or document is not found'
   },
   documentNotFound: {
     code: 'DOCUMENT_NOT_FOUND',

package/dist/cjs/errors/error-types.js

@@ -0,0 +1,43 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.NotInitializedError = exports.NotConnectedError = void 0;
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+var _assertThisInitialized2 = _interopRequireDefault(require("@babel/runtime/helpers/assertThisInitialized"));
+var _inherits2 = _interopRequireDefault(require("@babel/runtime/helpers/inherits"));
+var _possibleConstructorReturn2 = _interopRequireDefault(require("@babel/runtime/helpers/possibleConstructorReturn"));
+var _getPrototypeOf2 = _interopRequireDefault(require("@babel/runtime/helpers/getPrototypeOf"));
+var _wrapNativeSuper2 = _interopRequireDefault(require("@babel/runtime/helpers/wrapNativeSuper"));
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = (0, _getPrototypeOf2.default)(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = (0, _getPrototypeOf2.default)(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return (0, _possibleConstructorReturn2.default)(this, result); }; }
+function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
+var NotConnectedError = /*#__PURE__*/function (_Error) {
+  (0, _inherits2.default)(NotConnectedError, _Error);
+  var _super = _createSuper(NotConnectedError);
+  function NotConnectedError(message) {
+    var _this;
+    (0, _classCallCheck2.default)(this, NotConnectedError);
+    _this = _super.call(this, message);
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "name", 'NotConnectedError');
+    return _this;
+  }
+  return (0, _createClass2.default)(NotConnectedError);
+}( /*#__PURE__*/(0, _wrapNativeSuper2.default)(Error));
+exports.NotConnectedError = NotConnectedError;
+var NotInitializedError = /*#__PURE__*/function (_Error2) {
+  (0, _inherits2.default)(NotInitializedError, _Error2);
+  var _super2 = _createSuper(NotInitializedError);
+  function NotInitializedError(message) {
+    var _this2;
+    (0, _classCallCheck2.default)(this, NotInitializedError);
+    _this2 = _super2.call(this, message);
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this2), "name", 'NotInitializedError');
+    return _this2;
+  }
+  return (0, _createClass2.default)(NotInitializedError);
+}( /*#__PURE__*/(0, _wrapNativeSuper2.default)(Error));
+exports.NotInitializedError = NotInitializedError;