@atlaskit/collab-provider 8.4.0 → 8.6.0

package/dist/cjs/channel.js

@@ -1,11 +1,11 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _typeof = require("@babel/runtime/helpers/typeof");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.Channel = void 0;
-var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
@@ -16,7 +16,6 @@ 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("./errors/error-code-mapper");
 var _utils = require("./helpers/utils");
 var _performance = require("./analytics/performance");
 var _const = require("./helpers/const");
@@ -25,6 +24,7 @@ var _ufo = require("./analytics/ufo");
 var _disconnectedReasonMapper = require("./disconnected-reason-mapper");
 var _network = _interopRequireDefault(require("./connectivity/network"));
 var _errorTypes = require("./errors/error-types");
+function _regeneratorRuntime() { "use strict"; /*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/facebook/regenerator/blob/main/LICENSE */ _regeneratorRuntime = function _regeneratorRuntime() { return exports; }; var exports = {}, Op = Object.prototype, hasOwn = Op.hasOwnProperty, defineProperty = Object.defineProperty || function (obj, key, desc) { obj[key] = desc.value; }, $Symbol = "function" == typeof Symbol ? Symbol : {}, iteratorSymbol = $Symbol.iterator || "@@iterator", asyncIteratorSymbol = $Symbol.asyncIterator || "@@asyncIterator", toStringTagSymbol = $Symbol.toStringTag || "@@toStringTag"; function define(obj, key, value) { return Object.defineProperty(obj, key, { value: value, enumerable: !0, configurable: !0, writable: !0 }), obj[key]; } try { define({}, ""); } catch (err) { define = function define(obj, key, value) { return obj[key] = value; }; } function wrap(innerFn, outerFn, self, tryLocsList) { var protoGenerator = outerFn && outerFn.prototype instanceof Generator ? outerFn : Generator, generator = Object.create(protoGenerator.prototype), context = new Context(tryLocsList || []); return defineProperty(generator, "_invoke", { value: makeInvokeMethod(innerFn, self, context) }), generator; } function tryCatch(fn, obj, arg) { try { return { type: "normal", arg: fn.call(obj, arg) }; } catch (err) { return { type: "throw", arg: err }; } } exports.wrap = wrap; var ContinueSentinel = {}; function Generator() {} function GeneratorFunction() {} function GeneratorFunctionPrototype() {} var IteratorPrototype = {}; define(IteratorPrototype, iteratorSymbol, function () { return this; }); var getProto = Object.getPrototypeOf, NativeIteratorPrototype = getProto && getProto(getProto(values([]))); NativeIteratorPrototype && NativeIteratorPrototype !== Op && hasOwn.call(NativeIteratorPrototype, iteratorSymbol) && (IteratorPrototype = NativeIteratorPrototype); var Gp = GeneratorFunctionPrototype.prototype = Generator.prototype = Object.create(IteratorPrototype); function defineIteratorMethods(prototype) { ["next", "throw", "return"].forEach(function (method) { define(prototype, method, function (arg) { return this._invoke(method, arg); }); }); } function AsyncIterator(generator, PromiseImpl) { function invoke(method, arg, resolve, reject) { var record = tryCatch(generator[method], generator, arg); if ("throw" !== record.type) { var result = record.arg, value = result.value; return value && "object" == _typeof(value) && hasOwn.call(value, "__await") ? PromiseImpl.resolve(value.__await).then(function (value) { invoke("next", value, resolve, reject); }, function (err) { invoke("throw", err, resolve, reject); }) : PromiseImpl.resolve(value).then(function (unwrapped) { result.value = unwrapped, resolve(result); }, function (error) { return invoke("throw", error, resolve, reject); }); } reject(record.arg); } var previousPromise; defineProperty(this, "_invoke", { value: function value(method, arg) { function callInvokeWithMethodAndArg() { return new PromiseImpl(function (resolve, reject) { invoke(method, arg, resolve, reject); }); } return previousPromise = previousPromise ? previousPromise.then(callInvokeWithMethodAndArg, callInvokeWithMethodAndArg) : callInvokeWithMethodAndArg(); } }); } function makeInvokeMethod(innerFn, self, context) { var state = "suspendedStart"; return function (method, arg) { if ("executing" === state) throw new Error("Generator is already running"); if ("completed" === state) { if ("throw" === method) throw arg; return doneResult(); } for (context.method = method, context.arg = arg;;) { var delegate = context.delegate; if (delegate) { var delegateResult = maybeInvokeDelegate(delegate, context); if (delegateResult) { if (delegateResult === ContinueSentinel) continue; return delegateResult; } } if ("next" === context.method) context.sent = context._sent = context.arg;else if ("throw" === context.method) { if ("suspendedStart" === state) throw state = "completed", context.arg; context.dispatchException(context.arg); } else "return" === context.method && context.abrupt("return", context.arg); state = "executing"; var record = tryCatch(innerFn, self, context); if ("normal" === record.type) { if (state = context.done ? "completed" : "suspendedYield", record.arg === ContinueSentinel) continue; return { value: record.arg, done: context.done }; } "throw" === record.type && (state = "completed", context.method = "throw", context.arg = record.arg); } }; } function maybeInvokeDelegate(delegate, context) { var methodName = context.method, method = delegate.iterator[methodName]; if (undefined === method) return context.delegate = null, "throw" === methodName && delegate.iterator.return && (context.method = "return", context.arg = undefined, maybeInvokeDelegate(delegate, context), "throw" === context.method) || "return" !== methodName && (context.method = "throw", context.arg = new TypeError("The iterator does not provide a '" + methodName + "' method")), ContinueSentinel; var record = tryCatch(method, delegate.iterator, context.arg); if ("throw" === record.type) return context.method = "throw", context.arg = record.arg, context.delegate = null, ContinueSentinel; var info = record.arg; return info ? info.done ? (context[delegate.resultName] = info.value, context.next = delegate.nextLoc, "return" !== context.method && (context.method = "next", context.arg = undefined), context.delegate = null, ContinueSentinel) : info : (context.method = "throw", context.arg = new TypeError("iterator result is not an object"), context.delegate = null, ContinueSentinel); } function pushTryEntry(locs) { var entry = { tryLoc: locs[0] }; 1 in locs && (entry.catchLoc = locs[1]), 2 in locs && (entry.finallyLoc = locs[2], entry.afterLoc = locs[3]), this.tryEntries.push(entry); } function resetTryEntry(entry) { var record = entry.completion || {}; record.type = "normal", delete record.arg, entry.completion = record; } function Context(tryLocsList) { this.tryEntries = [{ tryLoc: "root" }], tryLocsList.forEach(pushTryEntry, this), this.reset(!0); } function values(iterable) { if (iterable) { var iteratorMethod = iterable[iteratorSymbol]; if (iteratorMethod) return iteratorMethod.call(iterable); if ("function" == typeof iterable.next) return iterable; if (!isNaN(iterable.length)) { var i = -1, next = function next() { for (; ++i < iterable.length;) { if (hasOwn.call(iterable, i)) return next.value = iterable[i], next.done = !1, next; } return next.value = undefined, next.done = !0, next; }; return next.next = next; } } return { next: doneResult }; } function doneResult() { return { value: undefined, done: !0 }; } return GeneratorFunction.prototype = GeneratorFunctionPrototype, defineProperty(Gp, "constructor", { value: GeneratorFunctionPrototype, configurable: !0 }), defineProperty(GeneratorFunctionPrototype, "constructor", { value: GeneratorFunction, configurable: !0 }), GeneratorFunction.displayName = define(GeneratorFunctionPrototype, toStringTagSymbol, "GeneratorFunction"), exports.isGeneratorFunction = function (genFun) { var ctor = "function" == typeof genFun && genFun.constructor; return !!ctor && (ctor === GeneratorFunction || "GeneratorFunction" === (ctor.displayName || ctor.name)); }, exports.mark = function (genFun) { return Object.setPrototypeOf ? Object.setPrototypeOf(genFun, GeneratorFunctionPrototype) : (genFun.__proto__ = GeneratorFunctionPrototype, define(genFun, toStringTagSymbol, "GeneratorFunction")), genFun.prototype = Object.create(Gp), genFun; }, exports.awrap = function (arg) { return { __await: arg }; }, defineIteratorMethods(AsyncIterator.prototype), define(AsyncIterator.prototype, asyncIteratorSymbol, function () { return this; }), exports.AsyncIterator = AsyncIterator, exports.async = function (innerFn, outerFn, self, tryLocsList, PromiseImpl) { void 0 === PromiseImpl && (PromiseImpl = Promise); var iter = new AsyncIterator(wrap(innerFn, outerFn, self, tryLocsList), PromiseImpl); return exports.isGeneratorFunction(outerFn) ? iter : iter.next().then(function (result) { return result.done ? result.value : iter.next(); }); }, defineIteratorMethods(Gp), define(Gp, toStringTagSymbol, "Generator"), define(Gp, iteratorSymbol, function () { return this; }), define(Gp, "toString", function () { return "[object Generator]"; }), exports.keys = function (val) { var object = Object(val), keys = []; for (var key in object) { keys.push(key); } return keys.reverse(), function next() { for (; keys.length;) { var key = keys.pop(); if (key in object) return next.value = key, next.done = !1, next; } return next.done = !0, next; }; }, exports.values = values, Context.prototype = { constructor: Context, reset: function reset(skipTempReset) { if (this.prev = 0, this.next = 0, this.sent = this._sent = undefined, this.done = !1, this.delegate = null, this.method = "next", this.arg = undefined, this.tryEntries.forEach(resetTryEntry), !skipTempReset) for (var name in this) { "t" === name.charAt(0) && hasOwn.call(this, name) && !isNaN(+name.slice(1)) && (this[name] = undefined); } }, stop: function stop() { this.done = !0; var rootRecord = this.tryEntries[0].completion; if ("throw" === rootRecord.type) throw rootRecord.arg; return this.rval; }, dispatchException: function dispatchException(exception) { if (this.done) throw exception; var context = this; function handle(loc, caught) { return record.type = "throw", record.arg = exception, context.next = loc, caught && (context.method = "next", context.arg = undefined), !!caught; } for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i], record = entry.completion; if ("root" === entry.tryLoc) return handle("end"); if (entry.tryLoc <= this.prev) { var hasCatch = hasOwn.call(entry, "catchLoc"), hasFinally = hasOwn.call(entry, "finallyLoc"); if (hasCatch && hasFinally) { if (this.prev < entry.catchLoc) return handle(entry.catchLoc, !0); if (this.prev < entry.finallyLoc) return handle(entry.finallyLoc); } else if (hasCatch) { if (this.prev < entry.catchLoc) return handle(entry.catchLoc, !0); } else { if (!hasFinally) throw new Error("try statement without catch or finally"); if (this.prev < entry.finallyLoc) return handle(entry.finallyLoc); } } } }, abrupt: function abrupt(type, arg) { for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i]; if (entry.tryLoc <= this.prev && hasOwn.call(entry, "finallyLoc") && this.prev < entry.finallyLoc) { var finallyEntry = entry; break; } } finallyEntry && ("break" === type || "continue" === type) && finallyEntry.tryLoc <= arg && arg <= finallyEntry.finallyLoc && (finallyEntry = null); var record = finallyEntry ? finallyEntry.completion : {}; return record.type = type, record.arg = arg, finallyEntry ? (this.method = "next", this.next = finallyEntry.finallyLoc, ContinueSentinel) : this.complete(record); }, complete: function complete(record, afterLoc) { if ("throw" === record.type) throw record.arg; return "break" === record.type || "continue" === record.type ? this.next = record.arg : "return" === record.type ? (this.rval = this.arg = record.arg, this.method = "return", this.next = "end") : "normal" === record.type && afterLoc && (this.next = afterLoc), ContinueSentinel; }, finish: function finish(finallyLoc) { for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i]; if (entry.finallyLoc === finallyLoc) return this.complete(entry.completion, entry.afterLoc), resetTryEntry(entry), ContinueSentinel; } }, catch: function _catch(tryLoc) { for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i]; if (entry.tryLoc === tryLoc) { var record = entry.completion; if ("throw" === record.type) { var thrown = record.arg; resetTryEntry(entry); } return thrown; } } throw new Error("illegal catch attempt"); }, delegateYield: function delegateYield(iterable, resultName, nextLoc) { return this.delegate = { iterator: values(iterable), resultName: resultName, nextLoc: nextLoc }, "next" === this.method && (this.arg = undefined), ContinueSentinel; } }, exports; }
 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); }; }
@@ -74,7 +74,7 @@ var Channel = /*#__PURE__*/function (_Emitter) {
       _this.unsetToken();
     });
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "onConnectError", function (error) {
-      var _this$analyticsHelper2, _this$analyticsHelper3;
+      var _this$analyticsHelper2, _this$analyticsHelper3, _message, _errorData$code;
       var measure = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.SOCKET_CONNECT, _this.analyticsHelper);
       (_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,
@@ -91,16 +91,21 @@ var Channel = /*#__PURE__*/function (_Emitter) {
       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: errorData
-      });
+      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;
@@ -108,13 +113,13 @@ var Channel = /*#__PURE__*/function (_Emitter) {
       if ((_this$reconnectHelper2 = _this.reconnectHelper) !== null && _this$reconnectHelper2 !== void 0 && _this$reconnectHelper2.isLikelyNetworkIssue()) {
         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.',
+        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 () {
@@ -176,6 +181,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__*/_regeneratorRuntime().mark(function _callee(fromVersion) {
+        var _ref2, _this$token, _yield$utils$requestS, doc, version, stepMaps, metadata, errorNotFound, errorCatchup;
+        return _regeneratorRuntime().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) {
@@ -191,6 +357,8 @@ var Channel = /*#__PURE__*/function (_Emitter) {
   }
 
   // read-only getters used for tests
+
+  // sets the token as undefined
   (0, _createClass2.default)(Channel, [{
     key: "connect",
     value:
@@ -199,7 +367,13 @@ var Channel = /*#__PURE__*/function (_Emitter) {
      */
     function connect() {
       var _this2 = this;
+      var shouldInitialize = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : false;
       (0, _performance.startMeasure)(_performance.MEASURE_NAME.SOCKET_CONNECT, this.analyticsHelper);
+      // If provider already has access to the initial draft, explicitly set channel as initialized
+      // to bypass BE doc retrieval
+      if (shouldInitialize) {
+        this.initialized = true;
+      }
       if (!this.initialized) {
         var _this$initExperience2;
         (0, _performance.startMeasure)(_performance.MEASURE_NAME.DOCUMENT_INIT, this.analyticsHelper);
@@ -221,58 +395,62 @@ var Channel = /*#__PURE__*/function (_Emitter) {
       };
       if (permissionTokenRefresh) {
         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) {
+          var _ref3 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regeneratorRuntime().mark(function _callee2(cb) {
+            var token, _err, _err$data, _err$data$meta, authenticationError;
+            return _regeneratorRuntime().wrap(function _callee2$(_context2) {
               while (1) {
-                switch (_context.prev = _context.next) {
+                switch (_context2.prev = _context2.next) {
                   case 0:
                     if (!(cacheToken && _this2.token)) {
-                      _context.next = 5;
+                      _context2.next = 5;
                       break;
                     }
                     authData.token = _this2.token;
                     cb(authData);
-                    _context.next = 17;
+                    _context2.next = 17;
                     break;
                   case 5:
-                    _context.prev = 5;
-                    _context.next = 8;
+                    _context2.prev = 5;
+                    _context2.next = 8;
                     return permissionTokenRefresh();
                   case 8:
-                    token = _context.sent;
+                    token = _context2.sent;
                     if (token) {
                       // save token locally
                       _this2.setToken(token);
                       authData.token = token;
                     }
                     cb(authData);
-                    _context.next = 17;
+                    _context2.next = 17;
                     break;
                   case 13:
-                    _context.prev = 13;
-                    _context.t0 = _context["catch"](5);
-                    newErr = {
-                      message: _context.t0.message ? _context.t0.message : 'Content not found',
+                    _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: _context.t0.data.code ? _context.t0.data.code : 'INSUFFICIENT_EDITING_PERMISSION',
+                        code: _errorTypes.INTERNAL_ERROR_CODE.TOKEN_PERMISSION_ERROR,
                         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'
+                          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', newErr);
+
+                    _this2.emit('error', authenticationError);
                   case 17:
                   case "end":
-                    return _context.stop();
+                    return _context2.stop();
                 }
               }
-            }, _callee, null, [[5, 13]]);
+            }, _callee2, null, [[5, 13]]);
           }));
-          return function auth(_x) {
-            return _ref.apply(this, arguments);
+          return function auth(_x2) {
+            return _ref3.apply(this, arguments);
           };
         }();
       } else {
@@ -300,11 +478,11 @@ var Channel = /*#__PURE__*/function (_Emitter) {
       this.socket.on('participant:left', function (data) {
         _this2.emit('participant:left', data);
       });
-      this.socket.on('participant:updated', function (_ref2) {
-        var sessionId = _ref2.sessionId,
-          timestamp = _ref2.timestamp,
-          data = _ref2.data,
-          clientId = _ref2.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,
@@ -320,11 +498,11 @@ var Channel = /*#__PURE__*/function (_Emitter) {
         _this2.emit('status', data);
       });
       this.socket.on('disconnect', /*#__PURE__*/function () {
-        var _ref3 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(reason) {
-          var _this2$analyticsHelpe;
-          return _regenerator.default.wrap(function _callee2$(_context2) {
+        var _ref5 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regeneratorRuntime().mark(function _callee3(reason) {
+          var _this2$analyticsHelpe, reconnectionError;
+          return _regeneratorRuntime().wrap(function _callee3$(_context3) {
             while (1) {
-              switch (_context2.prev = _context2.next) {
+              switch (_context3.prev = _context3.next) {
                 case 0:
                   _this2.connected = false;
                   logger("disconnect reason: ".concat(reason));
@@ -337,30 +515,31 @@ var Channel = /*#__PURE__*/function (_Emitter) {
                       _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 _context2.stop();
+                  return _context3.stop();
               }
             }
-          }, _callee2);
+          }, _callee3);
         }));
-        return function (_x2) {
-          return _ref3.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`.
@@ -380,178 +559,18 @@ 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 _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 (_context3.prev = _context3.next) {
-              case 0:
-                _context3.prev = 0;
-                _context3.t0 = _utilServiceSupport.utils;
-                _context3.t1 = this.config;
-                _context3.t2 = "document/".concat(encodeURIComponent(this.config.documentAri), "/catchup");
-                _context3.t3 = {
-                  version: fromVersion
-                };
-                _context3.t4 = _objectSpread;
-                _context3.t5 = _objectSpread;
-                _context3.t6 = {};
-                if (!this.config.permissionTokenRefresh) {
-                  _context3.next = 29;
-                  break;
-                }
-                if (!((_this$token = this.token) !== null && _this$token !== void 0)) {
-                  _context3.next = 13;
-                  break;
-                }
-                _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:
-                _context3.t9 = _context3.sent;
-              case 16:
-                _context3.t10 = _ref4 = _context3.t9;
-                _context3.t8 = _context3.t10 !== null;
-                if (!_context3.t8) {
-                  _context3.next = 20;
-                  break;
-                }
-                _context3.t8 = _ref4 !== void 0;
-              case 20:
-                if (!_context3.t8) {
-                  _context3.next = 24;
-                  break;
-                }
-                _context3.t11 = _ref4;
-                _context3.next = 25;
-                break;
-              case 24:
-                _context3.t11 = undefined;
-              case 25:
-                _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)
-                };
-                _context3.t17 = (0, _context3.t4)(_context3.t14, _context3.t15, _context3.t16);
-                _context3.t18 = {
-                  headers: _context3.t17
-                };
-                _context3.t19 = {
-                  path: _context3.t2,
-                  queryParams: _context3.t3,
-                  requestInit: _context3.t18
-                };
-                _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 _context3.abrupt("return", {
-                  doc: doc,
-                  version: version,
-                  stepMaps: stepMaps,
-                  metadata: metadata
-                });
-              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: _context3.t20.code,
-                    code: _errorCodeMapper.ErrorCodeMapper.documentNotFound.code
-                  }
-                };
-                this.emit('error', errorNotFound);
-                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: _context3.t20.status,
-                    code: _errorCodeMapper.ErrorCodeMapper.catchupFail.code
-                  }
-                };
-                this.emit('error', errorCatchup);
-                throw _context3.t20;
-              case 58:
-              case "end":
-                return _context3.stop();
-            }
-          }
-        }, _callee3, this, [[0, 47]]);
-      }));
-      function fetchCatchup(_x3) {
-        return _fetchCatchup.apply(this, arguments);
-      }
-      return fetchCatchup;
-    }()
+
     /**
-     * Send message to service. Timestamp will be added server side.
+     * Send message to the back-end service over the channel. Timestamp will be added server side.
+     * @throws {NotInitializedError} Channel not initialized
+     * @throws {NotConnectedError} Channel not connected
+     */
+
+    /**
+     * Send metadata to to the back-end service over the channel
+     * @throws {NotInitializedError} Channel not initialized
+     * @throws {NotConnectedError} Channel not connected
      */
-  }, {
-    key: "broadcast",
-    value: function broadcast(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);
-    }
-  }, {
-    key: "sendMetadata",
-    value: function sendMetadata(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);
-    }
   }, {
     key: "sendPresenceJoined",
     value: function sendPresenceJoined() {