@atlaskit/collab-provider 8.3.0 → 8.5.0

package/dist/cjs/channel.js

@@ -16,13 +16,14 @@ 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 _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,48 +50,87 @@ 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, _message, _errorData$code;
       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
+        // @ts-expect-error we should be more explicit about which type of errors we expect here, so they always have a status
+        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
-      });
+      var connectionError = {
+        message: (_message = error.message) !== null && _message !== void 0 ? _message : 'Connection error without message',
+        data: _objectSpread({
+          // @ts-expect-error I bet we'll see some connection errors, for the Socket IO errors
+          code: (_errorData$code = errorData === null || errorData === void 0 ? void 0 : errorData.code) !== null && _errorData$code !== void 0 ? _errorData$code : _errorTypes.INTERNAL_ERROR_CODE.CONNECTION_ERROR
+        }, errorData)
+      };
+      _this.emit('error', connectionError);
     });
     (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');
-        _this.emit('error', {
-          message: 'Reconnection failed 8 times when browser was offline, likely there was a network issue.',
+        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');
+        var reconnectionError = {
+          message: 'Reconnection failed 8 times when browser was offline, likely there was a network issue',
           data: {
-            status: 400,
-            code: 'RECONNECTION_NETWORK_ISSUE'
+            code: _errorTypes.INTERNAL_ERROR_CODE.RECONNECTION_NETWORK_ISSUE
           }
-        });
+        };
+        _this.emit('error', reconnectionError);
       }
     });
     (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 +142,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,
@@ -140,6 +180,167 @@ var Channel = /*#__PURE__*/function (_Emitter) {
         _this.emit('steps:added', data);
       }
     });
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "fetchCatchup", /*#__PURE__*/function () {
+      var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(fromVersion) {
+        var _ref2, _this$token, _yield$utils$requestS, doc, version, stepMaps, metadata, errorNotFound, errorCatchup;
+        return _regenerator.default.wrap(function _callee$(_context) {
+          while (1) {
+            switch (_context.prev = _context.next) {
+              case 0:
+                _context.prev = 0;
+                _context.t0 = _utilServiceSupport.utils;
+                _context.t1 = _this.config;
+                _context.t2 = "document/".concat(encodeURIComponent(_this.config.documentAri), "/catchup");
+                _context.t3 = {
+                  version: fromVersion
+                };
+                _context.t4 = _objectSpread;
+                _context.t5 = _objectSpread;
+                _context.t6 = {};
+                if (!_this.config.permissionTokenRefresh) {
+                  _context.next = 29;
+                  break;
+                }
+                if (!((_this$token = _this.token) !== null && _this$token !== void 0)) {
+                  _context.next = 13;
+                  break;
+                }
+                _context.t9 = _this$token;
+                _context.next = 16;
+                break;
+              case 13:
+                _context.next = 15;
+                return _this.config.permissionTokenRefresh().then(function (token) {
+                  if (token) {
+                    _this.setToken(token);
+                  }
+                  return token;
+                });
+              case 15:
+                _context.t9 = _context.sent;
+              case 16:
+                _context.t10 = _ref2 = _context.t9;
+                _context.t8 = _context.t10 !== null;
+                if (!_context.t8) {
+                  _context.next = 20;
+                  break;
+                }
+                _context.t8 = _ref2 !== void 0;
+              case 20:
+                if (!_context.t8) {
+                  _context.next = 24;
+                  break;
+                }
+                _context.t11 = _ref2;
+                _context.next = 25;
+                break;
+              case 24:
+                _context.t11 = undefined;
+              case 25:
+                _context.t12 = _context.t11;
+                _context.t7 = {
+                  'x-token': _context.t12
+                };
+                _context.next = 30;
+                break;
+              case 29:
+                _context.t7 = {};
+              case 30:
+                _context.t13 = _context.t7;
+                _context.t14 = (0, _context.t5)(_context.t6, _context.t13);
+                _context.t15 = {};
+                _context.t16 = {
+                  'x-product': (0, _utils.getProduct)(_this.config.productInfo),
+                  'x-subproduct': (0, _utils.getSubProduct)(_this.config.productInfo)
+                };
+                _context.t17 = (0, _context.t4)(_context.t14, _context.t15, _context.t16);
+                _context.t18 = {
+                  headers: _context.t17
+                };
+                _context.t19 = {
+                  path: _context.t2,
+                  queryParams: _context.t3,
+                  requestInit: _context.t18
+                };
+                _context.next = 39;
+                return _context.t0.requestService.call(_context.t0, _context.t1, _context.t19);
+              case 39:
+                _yield$utils$requestS = _context.sent;
+                doc = _yield$utils$requestS.doc;
+                version = _yield$utils$requestS.version;
+                stepMaps = _yield$utils$requestS.stepMaps;
+                metadata = _yield$utils$requestS.metadata;
+                return _context.abrupt("return", {
+                  doc: doc,
+                  version: version,
+                  stepMaps: stepMaps,
+                  metadata: metadata
+                });
+              case 47:
+                _context.prev = 47;
+                _context.t20 = _context["catch"](0);
+                if (!(_context.t20.code === 404)) {
+                  _context.next = 53;
+                  break;
+                }
+                errorNotFound = {
+                  message: 'The requested document is not found',
+                  data: {
+                    status: _context.t20.code,
+                    code: _errorTypes.INTERNAL_ERROR_CODE.DOCUMENT_NOT_FOUND
+                  }
+                };
+                _this.emit('error', errorNotFound);
+                return _context.abrupt("return", {});
+              case 53:
+                //nullify token so it is forced to generate new token on reconnect
+                _this.unsetToken();
+                logger("Can't fetch the catchup", _context.t20.message);
+                errorCatchup = {
+                  message: 'Cannot fetch catchup from collab service',
+                  data: {
+                    status: _context.t20.status,
+                    code: _errorTypes.INTERNAL_ERROR_CODE.CATCHUP_FAILED
+                  }
+                };
+                _this.emit('error', errorCatchup);
+                throw _context.t20;
+              case 58:
+              case "end":
+                return _context.stop();
+            }
+          }
+        }, _callee, null, [[0, 47]]);
+      }));
+      return function (_x) {
+        return _ref.apply(this, arguments);
+      };
+    }());
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "broadcast", function (type, data, callback) {
+      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({
+        type: type
+      }, data), callback);
+    });
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "sendMetadata", function (metadata) {
+      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);
+    });
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "onOnlineHandler", function () {
       // Force an immediate reconnect, the socket must first be closed to reset reconnection delay logic
       if (!_this.connected) {
@@ -173,34 +374,80 @@ 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 _ref3 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(cb) {
+            var token, _err, _err$data, _err$data$meta, authenticationError;
+            return _regenerator.default.wrap(function _callee2$(_context2) {
+              while (1) {
+                switch (_context2.prev = _context2.next) {
+                  case 0:
+                    if (!(cacheToken && _this2.token)) {
+                      _context2.next = 5;
+                      break;
+                    }
+                    authData.token = _this2.token;
+                    cb(authData);
+                    _context2.next = 17;
+                    break;
+                  case 5:
+                    _context2.prev = 5;
+                    _context2.next = 8;
+                    return permissionTokenRefresh();
+                  case 8:
+                    token = _context2.sent;
+                    if (token) {
+                      // save token locally
+                      _this2.setToken(token);
+                      authData.token = token;
+                    }
+                    cb(authData);
+                    _context2.next = 17;
+                    break;
+                  case 13:
+                    _context2.prev = 13;
+                    _context2.t0 = _context2["catch"](5);
+                    // Pass the error back to the consumers so they can deal with exceptional cases themselves (eg. no permissions because the page was deleted)
+                    authenticationError = {
+                      message: 'Insufficient editing permissions',
+                      data: {
+                        status: 403,
+                        code: _errorTypes.INTERNAL_ERROR_CODE.TOKEN_PERMISSION_ERROR,
+                        meta: {
+                          originalError: _context2.t0,
+                          // @ts-expect-error we know the error structure passed in this hack
+                          reason: (_err = err) === null || _err === void 0 ? void 0 : (_err$data = _err.data) === null || _err$data === void 0 ? void 0 : (_err$data$meta = _err$data.meta) === null || _err$data$meta === void 0 ? void 0 : _err$data$meta.reason // Should always be 'RESOURCE_DELETED' Temporary, until Confluence Cloud removes their hack
+                          // https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/browse/next/packages/native-collab/src/fetchCollabPermissionToken.ts#37
+                        }
+                      }
+                    };
+
+                    _this2.emit('error', authenticationError);
+                  case 17:
+                  case "end":
+                    return _context2.stop();
+                }
+              }
+            }, _callee2, null, [[5, 13]]);
+          }));
+          return function auth(_x2) {
+            return _ref3.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 +469,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 (_ref4) {
+        var sessionId = _ref4.sessionId,
+          timestamp = _ref4.timestamp,
+          data = _ref4.data,
+          clientId = _ref4.clientId;
         _this2.emit('participant:updated', _objectSpread({
           sessionId: sessionId,
           timestamp: timestamp,
@@ -242,52 +489,54 @@ 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 _this2$analyticsHelpe;
-          return _regenerator.default.wrap(function _callee$(_context) {
+        var _ref5 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3(reason) {
+          var _this2$analyticsHelpe, reconnectionError;
+          return _regenerator.default.wrap(function _callee3$(_context3) {
             while (1) {
-              switch (_context.prev = _context.next) {
+              switch (_context3.prev = _context3.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();
                     } catch (error) {
                       (_this2$analyticsHelpe = _this2.analyticsHelper) === null || _this2$analyticsHelpe === void 0 ? void 0 : _this2$analyticsHelpe.sendErrorEvent(error, 'Error while reconnecting the channel');
-                      _this2.emit('error', {
-                        message: 'Caught error during reconnection.',
+                      reconnectionError = {
+                        message: 'Caught error during reconnection',
                         data: {
                           status: 500,
-                          code: 'RECONNECTION_ERROR'
+                          code: _errorTypes.INTERNAL_ERROR_CODE.RECONNECTION_ERROR
                         }
-                      });
+                      };
+                      _this2.emit('error', reconnectionError);
                     }
                   }
                 case 4:
                 case "end":
-                  return _context.stop();
+                  return _context3.stop();
               }
             }
-          }, _callee);
+          }, _callee3);
         }));
-        return function (_x) {
-          return _ref2.apply(this, arguments);
+        return function (_x3) {
+          return _ref5.apply(this, arguments);
         };
       }());
 
       // Socket error, including errors from `packetMiddleware`, `controllers` and `onconnect` and more. Parameter is a plain JSON object.
-      this.socket.on('error', function (error) {
-        _this2.emit('error', error);
+      this.socket.on('error', function (socketError) {
+        _this2.emit('error', socketError);
       });
 
       // `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) {
@@ -301,149 +550,6 @@ var Channel = /*#__PURE__*/function (_Emitter) {
       // Fired upon a reconnection attempt error (from Socket.IO Manager)
       this.socket.io.on('reconnect_error', this.onReconnectError);
     }
-  }, {
-    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) {
-          while (1) {
-            switch (_context2.prev = _context2.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 = {
-                  version: fromVersion
-                };
-                _context2.t4 = _objectSpread;
-                _context2.t5 = _objectSpread;
-                _context2.t6 = {};
-                if (!this.config.permissionTokenRefresh) {
-                  _context2.next = 24;
-                  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;
-                  break;
-                }
-                _context2.t8 = _yield$this$config$pe !== void 0;
-              case 15:
-                if (!_context2.t8) {
-                  _context2.next = 19;
-                  break;
-                }
-                _context2.t10 = _yield$this$config$pe;
-                _context2.next = 20;
-                break;
-              case 19:
-                _context2.t10 = undefined;
-              case 20:
-                _context2.t11 = _context2.t10;
-                _context2.t7 = {
-                  'x-token': _context2.t11
-                };
-                _context2.next = 25;
-                break;
-              case 24:
-                _context2.t7 = {};
-              case 25:
-                _context2.t12 = _context2.t7;
-                _context2.t13 = (0, _context2.t5)(_context2.t6, _context2.t12);
-                _context2.t14 = {};
-                _context2.t15 = {
-                  '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
-                };
-                _context2.t18 = {
-                  path: _context2.t2,
-                  queryParams: _context2.t3,
-                  requestInit: _context2.t17
-                };
-                _context2.next = 34;
-                return _context2.t0.requestService.call(_context2.t0, _context2.t1, _context2.t18);
-              case 34:
-                _yield$utils$requestS = _context2.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", {
-                  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;
-                  break;
-                }
-                errorNotFound = {
-                  message: _errorCodeMapper.ErrorCodeMapper.documentNotFound.message,
-                  data: {
-                    status: _context2.t19.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);
-                errorCatchup = {
-                  message: _errorCodeMapper.ErrorCodeMapper.catchupFail.message,
-                  data: {
-                    status: _context2.t19.status,
-                    code: _errorCodeMapper.ErrorCodeMapper.catchupFail.code
-                  }
-                };
-                this.emit('error', errorCatchup);
-                throw _context2.t19;
-              case 52:
-              case "end":
-                return _context2.stop();
-            }
-          }
-        }, _callee2, this, [[0, 42]]);
-      }));
-      function fetchCatchup(_x2) {
-        return _fetchCatchup.apply(this, arguments);
-      }
-      return fetchCatchup;
-    }()
-    /**
-     * Send message to service. Timestamp will be added server side.
-     */
-  }, {
-    key: "broadcast",
-    value: function broadcast(type, data, callback) {
-      if (!this.connected || !this.socket) {
-        return;
-      }
-      this.socket.emit('broadcast', _objectSpread({
-        type: type
-      }, data), callback);
-    }
-  }, {
-    key: "sendMetadata",
-    value: function sendMetadata(metadata) {
-      if (!this.connected || !this.socket) {
-        return;
-      }
-      this.socket.emit('metadata', metadata);
-    }
   }, {
     key: "sendPresenceJoined",
     value: function sendPresenceJoined() {
@@ -459,6 +565,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/{provider → document}/catchup.js

@@ -115,12 +115,12 @@ var catchup = /*#__PURE__*/function () {
                     var stepMap = new _prosemirrorTransform.StepMap(ranges);
                     stepMap.inverted = inverted;
                     return stepMap;
-                  }); // create Mappng used for Step.map
+                  }); // create Mapping used for Step.map
                   mapping = new _prosemirrorTransform.Mapping(stepMaps);
                   logger("".concat(_unconfirmedSteps.length, " unconfirmed steps before rebased: ").concat(JSON.stringify(_unconfirmedSteps)));
                   newUnconfirmedSteps = rebaseSteps(_unconfirmedSteps, mapping);
                   logger("Re-aply ".concat(newUnconfirmedSteps.length, " mapped unconfirmed steps: ").concat(JSON.stringify(newUnconfirmedSteps)));
-                  // Re-aply local steps
+                  // Re-apply local steps
                   opt.applyLocalSteps(newUnconfirmedSteps);
                 }
               }