@atlaskit/collab-provider 9.26.4 → 9.26.6

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @atlaskit/collab-provider
 
+## 9.26.6
+
+### Patch Changes
+
+- [#92490](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/92490) [`97780ddb724d`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/97780ddb724d) - refactor channel to reduce code duplication
+
+## 9.26.5
+
+### Patch Changes
+
+- [#91579](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/91579) [`99a74057c77a`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/99a74057c77a) - Handle undefined steps in catchup v2
+- Updated dependencies
+
 ## 9.26.4
 
 ### Patch Changes

package/dist/cjs/channel.js

@@ -241,44 +241,21 @@ var Channel = exports.Channel = /*#__PURE__*/function (_Emitter) {
                 version: fromVersion,
                 clientId: clientId
               };
-              _context2.t4 = _objectSpread;
-              _context2.t5 = _objectSpread;
-              _context2.t6 = {};
-              if (!_this.config.permissionTokenRefresh) {
-                _context2.next = 15;
-                break;
-              }
-              _context2.next = 11;
-              return _this.getChannelToken();
-            case 11:
-              _context2.t8 = _context2.sent;
-              _context2.t7 = {
-                'x-token': _context2.t8
-              };
-              _context2.next = 16;
-              break;
-            case 15:
-              _context2.t7 = {};
-            case 16:
-              _context2.t9 = _context2.t7;
-              _context2.t10 = (0, _context2.t5)(_context2.t6, _context2.t9);
-              _context2.t11 = {};
-              _context2.t12 = {
-                'x-product': (0, _utils.getProduct)(_this.config.productInfo),
-                'x-subproduct': (0, _utils.getSubProduct)(_this.config.productInfo)
-              };
-              _context2.t13 = (0, _context2.t4)(_context2.t10, _context2.t11, _context2.t12);
-              _context2.t14 = {
-                headers: _context2.t13
+              _context2.next = 7;
+              return _this.commonHeaders();
+            case 7:
+              _context2.t4 = _context2.sent;
+              _context2.t5 = {
+                headers: _context2.t4
               };
-              _context2.t15 = {
+              _context2.t6 = {
                 path: _context2.t2,
                 queryParams: _context2.t3,
-                requestInit: _context2.t14
+                requestInit: _context2.t5
               };
-              _context2.next = 25;
-              return _context2.t0.requestService.call(_context2.t0, _context2.t1, _context2.t15);
-            case 25:
+              _context2.next = 12;
+              return _context2.t0.requestService.call(_context2.t0, _context2.t1, _context2.t6);
+            case 12:
               _yield$utils$requestS = _context2.sent;
               doc = _yield$utils$requestS.doc;
               version = _yield$utils$requestS.version;
@@ -290,38 +267,38 @@ var Channel = exports.Channel = /*#__PURE__*/function (_Emitter) {
                 stepMaps: stepMaps,
                 metadata: metadata
               });
-            case 33:
-              _context2.prev = 33;
-              _context2.t16 = _context2["catch"](0);
-              if (!(_context2.t16.code === 404)) {
-                _context2.next = 39;
+            case 20:
+              _context2.prev = 20;
+              _context2.t7 = _context2["catch"](0);
+              if (!(_context2.t7.code === 404)) {
+                _context2.next = 26;
                 break;
               }
               errorNotFound = {
                 message: 'The requested document is not found',
                 data: {
-                  status: _context2.t16.code,
+                  status: _context2.t7.code,
                   code: _internalErrors.INTERNAL_ERROR_CODE.DOCUMENT_NOT_FOUND
                 }
               };
               _this.emit('error', errorNotFound);
               return _context2.abrupt("return", {});
-            case 39:
-              logger("Can't fetch the catchup", _context2.t16.message);
+            case 26:
+              logger("Can't fetch the catchup", _context2.t7.message);
               errorCatchup = {
                 message: 'Cannot fetch catchup from collab service',
                 data: {
-                  status: _context2.t16.status,
+                  status: _context2.t7.status,
                   code: _internalErrors.INTERNAL_ERROR_CODE.CATCHUP_FAILED
                 }
               };
               _this.emit('error', errorCatchup);
-              throw _context2.t16;
-            case 43:
+              throw _context2.t7;
+            case 30:
             case "end":
               return _context2.stop();
           }
-        }, _callee2, null, [[0, 33]]);
+        }, _callee2, null, [[0, 20]]);
       }));
       return function (_x, _x2) {
         return _ref2.apply(this, arguments);
@@ -342,44 +319,21 @@ var Channel = exports.Channel = /*#__PURE__*/function (_Emitter) {
                 clientId: clientId,
                 catchUpOutofSync: catchUpOutofSync
               };
-              _context3.t4 = _objectSpread;
-              _context3.t5 = _objectSpread;
-              _context3.t6 = {};
-              if (!_this.config.permissionTokenRefresh) {
-                _context3.next = 15;
-                break;
-              }
-              _context3.next = 11;
-              return _this.getChannelToken();
-            case 11:
-              _context3.t8 = _context3.sent;
-              _context3.t7 = {
-                'x-token': _context3.t8
-              };
-              _context3.next = 16;
-              break;
-            case 15:
-              _context3.t7 = {};
-            case 16:
-              _context3.t9 = _context3.t7;
-              _context3.t10 = (0, _context3.t5)(_context3.t6, _context3.t9);
-              _context3.t11 = {};
-              _context3.t12 = {
-                'x-product': (0, _utils.getProduct)(_this.config.productInfo),
-                'x-subproduct': (0, _utils.getSubProduct)(_this.config.productInfo)
+              _context3.next = 7;
+              return _this.commonHeaders();
+            case 7:
+              _context3.t4 = _context3.sent;
+              _context3.t5 = {
+                headers: _context3.t4
               };
-              _context3.t13 = (0, _context3.t4)(_context3.t10, _context3.t11, _context3.t12);
-              _context3.t14 = {
-                headers: _context3.t13
-              };
-              _context3.t15 = {
+              _context3.t6 = {
                 path: _context3.t2,
                 queryParams: _context3.t3,
-                requestInit: _context3.t14
+                requestInit: _context3.t5
               };
-              _context3.next = 25;
-              return _context3.t0.requestService.call(_context3.t0, _context3.t1, _context3.t15);
-            case 25:
+              _context3.next = 12;
+              return _context3.t0.requestService.call(_context3.t0, _context3.t1, _context3.t6);
+            case 12:
               _yield$utils$requestS2 = _context3.sent;
               steps = _yield$utils$requestS2.steps;
               metadata = _yield$utils$requestS2.metadata;
@@ -387,38 +341,38 @@ var Channel = exports.Channel = /*#__PURE__*/function (_Emitter) {
                 steps: steps,
                 metadata: metadata
               });
-            case 31:
-              _context3.prev = 31;
-              _context3.t16 = _context3["catch"](0);
-              if (!(_context3.t16.code === 404)) {
-                _context3.next = 37;
+            case 18:
+              _context3.prev = 18;
+              _context3.t7 = _context3["catch"](0);
+              if (!(_context3.t7.code === 404)) {
+                _context3.next = 24;
                 break;
               }
               errorNotFound = {
                 message: 'The requested document is not found',
                 data: {
-                  status: _context3.t16.code,
+                  status: _context3.t7.code,
                   code: _internalErrors.INTERNAL_ERROR_CODE.DOCUMENT_NOT_FOUND
                 }
               };
               _this.emit('error', errorNotFound);
               return _context3.abrupt("return", {});
-            case 37:
-              logger("Can't fetch the catchupv2", _context3.t16.message);
+            case 24:
+              logger("Can't fetch the catchupv2", _context3.t7.message);
               errorCatchupv2 = {
                 message: 'Cannot fetch catchupv2 from collab service',
                 data: {
-                  status: _context3.t16.status,
+                  status: _context3.t7.status,
                   code: _internalErrors.INTERNAL_ERROR_CODE.CATCHUP_FAILED
                 }
               };
               _this.emit('error', errorCatchupv2);
-              throw _context3.t16;
-            case 41:
+              throw _context3.t7;
+            case 28:
             case "end":
               return _context3.stop();
           }
-        }, _callee3, null, [[0, 31]]);
+        }, _callee3, null, [[0, 18]]);
       }));
       return function (_x3, _x4, _x5) {
         return _ref3.apply(this, arguments);
@@ -442,56 +396,41 @@ var Channel = exports.Channel = /*#__PURE__*/function (_Emitter) {
               _context4.t3 = _objectSpread;
               _context4.t4 = _objectSpread;
               _context4.t5 = {};
-              if (!_this.config.permissionTokenRefresh) {
-                _context4.next = 15;
-                break;
-              }
-              _context4.next = 11;
-              return _this.getChannelToken();
-            case 11:
-              _context4.t7 = _context4.sent;
-              _context4.t6 = {
-                'x-token': _context4.t7
-              };
-              _context4.next = 16;
-              break;
-            case 15:
-              _context4.t6 = {};
-            case 16:
-              _context4.t8 = _context4.t6;
-              _context4.t9 = (0, _context4.t4)(_context4.t5, _context4.t8);
-              _context4.t10 = {};
-              _context4.t11 = {
-                'x-product': (0, _utils.getProduct)(_this.config.productInfo),
-                'x-subproduct': (0, _utils.getSubProduct)(_this.config.productInfo),
+              _context4.next = 10;
+              return _this.commonHeaders();
+            case 10:
+              _context4.t6 = _context4.sent;
+              _context4.t7 = (0, _context4.t4)(_context4.t5, _context4.t6);
+              _context4.t8 = {};
+              _context4.t9 = {
                 'Content-Type': 'application/json'
               };
-              _context4.t12 = (0, _context4.t3)(_context4.t9, _context4.t10, _context4.t11);
-              _context4.t13 = reqBody;
-              _context4.t14 = {
-                headers: _context4.t12,
+              _context4.t10 = (0, _context4.t3)(_context4.t7, _context4.t8, _context4.t9);
+              _context4.t11 = reqBody;
+              _context4.t12 = {
+                headers: _context4.t10,
                 method: 'POST',
-                body: _context4.t13
+                body: _context4.t11
               };
-              _context4.t15 = {
+              _context4.t13 = {
                 path: _context4.t2,
-                requestInit: _context4.t14
+                requestInit: _context4.t12
               };
-              _context4.next = 26;
-              return _context4.t0.requestService.call(_context4.t0, _context4.t1, _context4.t15);
-            case 26:
+              _context4.next = 20;
+              return _context4.t0.requestService.call(_context4.t0, _context4.t1, _context4.t13);
+            case 20:
               reconcileResponse = _context4.sent;
               return _context4.abrupt("return", reconcileResponse);
-            case 30:
-              _context4.prev = 30;
-              _context4.t16 = _context4["catch"](0);
-              (_this$analyticsHelper7 = _this.analyticsHelper) === null || _this$analyticsHelper7 === void 0 || _this$analyticsHelper7.sendErrorEvent(_context4.t16, 'Error while fetching reconciled document');
-              throw _context4.t16;
-            case 34:
+            case 24:
+              _context4.prev = 24;
+              _context4.t14 = _context4["catch"](0);
+              (_this$analyticsHelper7 = _this.analyticsHelper) === null || _this$analyticsHelper7 === void 0 || _this$analyticsHelper7.sendErrorEvent(_context4.t14, 'Error while fetching reconciled document');
+              throw _context4.t14;
+            case 28:
             case "end":
               return _context4.stop();
           }
-        }, _callee4, null, [[0, 30]]);
+        }, _callee4, null, [[0, 24]]);
       }));
       return function (_x6, _x7) {
         return _ref4.apply(this, arguments);
@@ -843,6 +782,51 @@ var Channel = exports.Channel = /*#__PURE__*/function (_Emitter) {
         _iterator.f();
       }
     }
+  }, {
+    key: "commonHeaders",
+    value: function () {
+      var _commonHeaders = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee8() {
+        return _regenerator.default.wrap(function _callee8$(_context8) {
+          while (1) switch (_context8.prev = _context8.next) {
+            case 0:
+              _context8.t0 = _objectSpread;
+              _context8.t1 = _objectSpread;
+              _context8.t2 = {};
+              if (!this.config.permissionTokenRefresh) {
+                _context8.next = 10;
+                break;
+              }
+              _context8.next = 6;
+              return this.getChannelToken();
+            case 6:
+              _context8.t4 = _context8.sent;
+              _context8.t3 = {
+                'x-token': _context8.t4
+              };
+              _context8.next = 11;
+              break;
+            case 10:
+              _context8.t3 = {};
+            case 11:
+              _context8.t5 = _context8.t3;
+              _context8.t6 = (0, _context8.t1)(_context8.t2, _context8.t5);
+              _context8.t7 = {};
+              _context8.t8 = {
+                'x-product': (0, _utils.getProduct)(this.config.productInfo),
+                'x-subproduct': (0, _utils.getSubProduct)(this.config.productInfo)
+              };
+              return _context8.abrupt("return", (0, _context8.t0)(_context8.t6, _context8.t7, _context8.t8));
+            case 16:
+            case "end":
+              return _context8.stop();
+          }
+        }, _callee8, this);
+      }));
+      function commonHeaders() {
+        return _commonHeaders.apply(this, arguments);
+      }
+      return commonHeaders;
+    }()
   }, {
     key: "isLimitExceeded",
     value: function isLimitExceeded(stepLimit, stepSizeLimit, maxStepSizeLimit) {

package/dist/cjs/document/catchupv2.js

@@ -4,13 +4,10 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.catchupv2 = void 0;
+exports.isOutOfSync = exports.catchupv2 = void 0;
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
 var _utils = require("../helpers/utils");
-function _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e) { throw _e; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e2) { didErr = true; err = _e2; }, f: function f() { try { if (!normalCompletion && it.return != null) it.return(); } finally { if (didErr) throw err; } } }; }
-function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
-function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
 var logger = (0, _utils.createLogger)('Catchupv2', 'red');
 var catchupv2 = exports.catchupv2 = /*#__PURE__*/function () {
   var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(opt) {
@@ -36,6 +33,13 @@ var catchupv2 = exports.catchupv2 = /*#__PURE__*/function () {
           throw _context.t0;
         case 14:
           _context.prev = 14;
+          if (!(!steps || steps.length === 0)) {
+            _context.next = 18;
+            break;
+          }
+          opt.updateMetadata(metadata);
+          return _context.abrupt("return", false);
+        case 18:
           version = fromVersion + steps.length;
           stepsPayload = {
             version: version,
@@ -44,42 +48,36 @@ var catchupv2 = exports.catchupv2 = /*#__PURE__*/function () {
           opt.onStepsAdded(stepsPayload);
           opt.updateMetadata(metadata);
           return _context.abrupt("return", Boolean(opt.clientId && isOutOfSync(fromVersion, opt.getCurrentPmVersion(), steps, opt.clientId)));
-        case 22:
-          _context.prev = 22;
+        case 25:
+          _context.prev = 25;
           _context.t1 = _context["catch"](14);
           (_opt$analyticsHelper2 = opt.analyticsHelper) === null || _opt$analyticsHelper2 === void 0 || _opt$analyticsHelper2.sendErrorEvent(_context.t1, 'Failed to apply catchupv2 result in the editor');
           logger("Apply catchupv2 steps failed:", _context.t1.message);
           throw _context.t1;
-        case 27:
+        case 30:
         case "end":
           return _context.stop();
       }
-    }, _callee, null, [[1, 9], [14, 22]]);
+    }, _callee, null, [[1, 9], [14, 25]]);
   }));
   return function catchupv2(_x) {
     return _ref.apply(this, arguments);
   };
 }();
-var isOutOfSync = function isOutOfSync(fromVersion, currentVersion, steps, clientId) {
+
+/**
+ * Checks if we're out of sync with the backend because catchup failed to apply, and thus the doc should be reset.
+ * @param fromVersion The document's PM version from before we applied catchup
+ * @param currentVersion The document's PM version after we applied catchup
+ * @param steps Steps returned to us by catchup
+ * @param clientId The ID of the currently connected session (one user can have multiple if theu have multiple tabs open)
+ * @returns True if we're out of sync, false if not.
+ */
+var isOutOfSync = exports.isOutOfSync = function isOutOfSync(fromVersion, currentVersion, steps, clientId) {
   return (
     // If version number hasn't increased, and steps are not from our client, we're out of sync
-    Boolean(fromVersion >= currentVersion && checkForeignSteps(steps, clientId))
+    Boolean(fromVersion >= currentVersion && steps.some(function (step) {
+      return step.clientId !== clientId;
+    }))
   );
-};
-var checkForeignSteps = function checkForeignSteps(steps, clientId) {
-  var _iterator = _createForOfIteratorHelper(steps),
-    _step;
-  try {
-    for (_iterator.s(); !(_step = _iterator.n()).done;) {
-      var step = _step.value;
-      if (step.clientId !== clientId) {
-        return true;
-      }
-    }
-  } catch (err) {
-    _iterator.e(err);
-  } finally {
-    _iterator.f();
-  }
-  return false;
 };

package/dist/cjs/version-wrapper.js

@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.version = exports.nextMajorVersion = exports.name = void 0;
 var name = exports.name = "@atlaskit/collab-provider";
-var version = exports.version = "9.26.4";
+var version = exports.version = "9.26.6";
 var nextMajorVersion = exports.nextMajorVersion = function nextMajorVersion() {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

package/dist/es2019/channel.js

@@ -176,13 +176,7 @@ export class Channel extends Emitter {
             clientId: clientId
           },
           requestInit: {
-            headers: {
-              ...(this.config.permissionTokenRefresh ? {
-                'x-token': await this.getChannelToken()
-              } : {}),
-              'x-product': getProduct(this.config.productInfo),
-              'x-subproduct': getSubProduct(this.config.productInfo)
-            }
+            headers: await this.commonHeaders()
           }
         });
         return {
@@ -228,13 +222,7 @@ export class Channel extends Emitter {
             catchUpOutofSync
           },
           requestInit: {
-            headers: {
-              ...(this.config.permissionTokenRefresh ? {
-                'x-token': await this.getChannelToken()
-              } : {}),
-              'x-product': getProduct(this.config.productInfo),
-              'x-subproduct': getSubProduct(this.config.productInfo)
-            }
+            headers: await this.commonHeaders()
           }
         });
         return {
@@ -276,11 +264,7 @@ export class Channel extends Emitter {
           path: `document/${encodeURIComponent(this.config.documentAri)}/reconcile`,
           requestInit: {
             headers: {
-              ...(this.config.permissionTokenRefresh ? {
-                'x-token': await this.getChannelToken()
-              } : {}),
-              'x-product': getProduct(this.config.productInfo),
-              'x-subproduct': getSubProduct(this.config.productInfo),
+              ...(await this.commonHeaders()),
               'Content-Type': 'application/json'
             },
             method: 'POST',
@@ -570,6 +554,15 @@ export class Channel extends Emitter {
       }
     }
   }
+  async commonHeaders() {
+    return {
+      ...(this.config.permissionTokenRefresh ? {
+        'x-token': await this.getChannelToken()
+      } : {}),
+      'x-product': getProduct(this.config.productInfo),
+      'x-subproduct': getSubProduct(this.config.productInfo)
+    };
+  }
   isLimitExceeded(stepLimit, stepSizeLimit, maxStepSizeLimit) {
     return stepLimit > 0 && this.stepCounter > stepLimit || stepSizeLimit > 0 && this.stepSizeCounter > stepSizeLimit || maxStepSizeLimit > 0 && this.maxStepSize > maxStepSizeLimit;
   }

package/dist/es2019/document/catchupv2.js

@@ -16,6 +16,11 @@ export const catchupv2 = async opt => {
     throw error;
   }
   try {
+    // skip onStepsAdded if steps are undefined or empty
+    if (!steps || steps.length === 0) {
+      opt.updateMetadata(metadata);
+      return false;
+    }
     const version = fromVersion + steps.length;
     const stepsPayload = {
       version,
@@ -31,14 +36,15 @@ export const catchupv2 = async opt => {
     throw error;
   }
 };
-const isOutOfSync = (fromVersion, currentVersion, steps, clientId) =>
+
+/**
+ * Checks if we're out of sync with the backend because catchup failed to apply, and thus the doc should be reset.
+ * @param fromVersion The document's PM version from before we applied catchup
+ * @param currentVersion The document's PM version after we applied catchup
+ * @param steps Steps returned to us by catchup
+ * @param clientId The ID of the currently connected session (one user can have multiple if theu have multiple tabs open)
+ * @returns True if we're out of sync, false if not.
+ */
+export const isOutOfSync = (fromVersion, currentVersion, steps, clientId) =>
 // If version number hasn't increased, and steps are not from our client, we're out of sync
-Boolean(fromVersion >= currentVersion && checkForeignSteps(steps, clientId));
-const checkForeignSteps = (steps, clientId) => {
-  for (const step of steps) {
-    if (step.clientId !== clientId) {
-      return true;
-    }
-  }
-  return false;
-};
+Boolean(fromVersion >= currentVersion && steps.some(step => step.clientId !== clientId));

package/dist/es2019/document/document-service.js

@@ -130,6 +130,18 @@ export class DocumentService {
       this.stepQueue.pauseQueue();
       try {
         var _this$analyticsHelper3;
+        /**
+         * We have two options when out of sync:
+         * - Check a boolean that ensures we reset the document next time we catchup
+         * - Immediately catchup
+         *
+         * Immediately catching up has some complexity invovled with it - do we call catchupv2 again, fetchCatchupv2 again, or documentService.catchupV2 again?
+         * If we call either catchupv2 or documentService.catchupv2, we run the risk of creating an infinite loop of reset catchup requests.
+         * We can slow down the loop by calling throttledCatchupv2, and can add booleans that check if we're already doing a reset catchup request.
+         *
+         * But this all adds complexity that can be avoided by choosing the first option.
+         * Collab provider will already call catchup again, so this time we can ensure we call it with reset.
+         */
         this.catchUpOutofSync = await catchupv2({
           getCurrentPmVersion: this.getCurrentPmVersion,
           fetchCatchupv2: this.fetchCatchupv2,

package/dist/es2019/version-wrapper.js

@@ -1,5 +1,5 @@
 export const name = "@atlaskit/collab-provider";
-export const version = "9.26.4";
+export const version = "9.26.6";
 export const nextMajorVersion = () => {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

package/dist/esm/channel.js

@@ -234,44 +234,21 @@ export var Channel = /*#__PURE__*/function (_Emitter) {
                 version: fromVersion,
                 clientId: clientId
               };
-              _context2.t4 = _objectSpread;
-              _context2.t5 = _objectSpread;
-              _context2.t6 = {};
-              if (!_this.config.permissionTokenRefresh) {
-                _context2.next = 15;
-                break;
-              }
-              _context2.next = 11;
-              return _this.getChannelToken();
-            case 11:
-              _context2.t8 = _context2.sent;
-              _context2.t7 = {
-                'x-token': _context2.t8
-              };
-              _context2.next = 16;
-              break;
-            case 15:
-              _context2.t7 = {};
-            case 16:
-              _context2.t9 = _context2.t7;
-              _context2.t10 = (0, _context2.t5)(_context2.t6, _context2.t9);
-              _context2.t11 = {};
-              _context2.t12 = {
-                'x-product': getProduct(_this.config.productInfo),
-                'x-subproduct': getSubProduct(_this.config.productInfo)
-              };
-              _context2.t13 = (0, _context2.t4)(_context2.t10, _context2.t11, _context2.t12);
-              _context2.t14 = {
-                headers: _context2.t13
+              _context2.next = 7;
+              return _this.commonHeaders();
+            case 7:
+              _context2.t4 = _context2.sent;
+              _context2.t5 = {
+                headers: _context2.t4
               };
-              _context2.t15 = {
+              _context2.t6 = {
                 path: _context2.t2,
                 queryParams: _context2.t3,
-                requestInit: _context2.t14
+                requestInit: _context2.t5
               };
-              _context2.next = 25;
-              return _context2.t0.requestService.call(_context2.t0, _context2.t1, _context2.t15);
-            case 25:
+              _context2.next = 12;
+              return _context2.t0.requestService.call(_context2.t0, _context2.t1, _context2.t6);
+            case 12:
               _yield$utils$requestS = _context2.sent;
               doc = _yield$utils$requestS.doc;
               version = _yield$utils$requestS.version;
@@ -283,38 +260,38 @@ export var Channel = /*#__PURE__*/function (_Emitter) {
                 stepMaps: stepMaps,
                 metadata: metadata
               });
-            case 33:
-              _context2.prev = 33;
-              _context2.t16 = _context2["catch"](0);
-              if (!(_context2.t16.code === 404)) {
-                _context2.next = 39;
+            case 20:
+              _context2.prev = 20;
+              _context2.t7 = _context2["catch"](0);
+              if (!(_context2.t7.code === 404)) {
+                _context2.next = 26;
                 break;
               }
               errorNotFound = {
                 message: 'The requested document is not found',
                 data: {
-                  status: _context2.t16.code,
+                  status: _context2.t7.code,
                   code: INTERNAL_ERROR_CODE.DOCUMENT_NOT_FOUND
                 }
               };
               _this.emit('error', errorNotFound);
               return _context2.abrupt("return", {});
-            case 39:
-              logger("Can't fetch the catchup", _context2.t16.message);
+            case 26:
+              logger("Can't fetch the catchup", _context2.t7.message);
               errorCatchup = {
                 message: 'Cannot fetch catchup from collab service',
                 data: {
-                  status: _context2.t16.status,
+                  status: _context2.t7.status,
                   code: INTERNAL_ERROR_CODE.CATCHUP_FAILED
                 }
               };
               _this.emit('error', errorCatchup);
-              throw _context2.t16;
-            case 43:
+              throw _context2.t7;
+            case 30:
             case "end":
               return _context2.stop();
           }
-        }, _callee2, null, [[0, 33]]);
+        }, _callee2, null, [[0, 20]]);
       }));
       return function (_x, _x2) {
         return _ref2.apply(this, arguments);
@@ -335,44 +312,21 @@ export var Channel = /*#__PURE__*/function (_Emitter) {
                 clientId: clientId,
                 catchUpOutofSync: catchUpOutofSync
               };
-              _context3.t4 = _objectSpread;
-              _context3.t5 = _objectSpread;
-              _context3.t6 = {};
-              if (!_this.config.permissionTokenRefresh) {
-                _context3.next = 15;
-                break;
-              }
-              _context3.next = 11;
-              return _this.getChannelToken();
-            case 11:
-              _context3.t8 = _context3.sent;
-              _context3.t7 = {
-                'x-token': _context3.t8
-              };
-              _context3.next = 16;
-              break;
-            case 15:
-              _context3.t7 = {};
-            case 16:
-              _context3.t9 = _context3.t7;
-              _context3.t10 = (0, _context3.t5)(_context3.t6, _context3.t9);
-              _context3.t11 = {};
-              _context3.t12 = {
-                'x-product': getProduct(_this.config.productInfo),
-                'x-subproduct': getSubProduct(_this.config.productInfo)
+              _context3.next = 7;
+              return _this.commonHeaders();
+            case 7:
+              _context3.t4 = _context3.sent;
+              _context3.t5 = {
+                headers: _context3.t4
               };
-              _context3.t13 = (0, _context3.t4)(_context3.t10, _context3.t11, _context3.t12);
-              _context3.t14 = {
-                headers: _context3.t13
-              };
-              _context3.t15 = {
+              _context3.t6 = {
                 path: _context3.t2,
                 queryParams: _context3.t3,
-                requestInit: _context3.t14
+                requestInit: _context3.t5
               };
-              _context3.next = 25;
-              return _context3.t0.requestService.call(_context3.t0, _context3.t1, _context3.t15);
-            case 25:
+              _context3.next = 12;
+              return _context3.t0.requestService.call(_context3.t0, _context3.t1, _context3.t6);
+            case 12:
               _yield$utils$requestS2 = _context3.sent;
               steps = _yield$utils$requestS2.steps;
               metadata = _yield$utils$requestS2.metadata;
@@ -380,38 +334,38 @@ export var Channel = /*#__PURE__*/function (_Emitter) {
                 steps: steps,
                 metadata: metadata
               });
-            case 31:
-              _context3.prev = 31;
-              _context3.t16 = _context3["catch"](0);
-              if (!(_context3.t16.code === 404)) {
-                _context3.next = 37;
+            case 18:
+              _context3.prev = 18;
+              _context3.t7 = _context3["catch"](0);
+              if (!(_context3.t7.code === 404)) {
+                _context3.next = 24;
                 break;
               }
               errorNotFound = {
                 message: 'The requested document is not found',
                 data: {
-                  status: _context3.t16.code,
+                  status: _context3.t7.code,
                   code: INTERNAL_ERROR_CODE.DOCUMENT_NOT_FOUND
                 }
               };
               _this.emit('error', errorNotFound);
               return _context3.abrupt("return", {});
-            case 37:
-              logger("Can't fetch the catchupv2", _context3.t16.message);
+            case 24:
+              logger("Can't fetch the catchupv2", _context3.t7.message);
               errorCatchupv2 = {
                 message: 'Cannot fetch catchupv2 from collab service',
                 data: {
-                  status: _context3.t16.status,
+                  status: _context3.t7.status,
                   code: INTERNAL_ERROR_CODE.CATCHUP_FAILED
                 }
               };
               _this.emit('error', errorCatchupv2);
-              throw _context3.t16;
-            case 41:
+              throw _context3.t7;
+            case 28:
             case "end":
               return _context3.stop();
           }
-        }, _callee3, null, [[0, 31]]);
+        }, _callee3, null, [[0, 18]]);
       }));
       return function (_x3, _x4, _x5) {
         return _ref3.apply(this, arguments);
@@ -435,56 +389,41 @@ export var Channel = /*#__PURE__*/function (_Emitter) {
               _context4.t3 = _objectSpread;
               _context4.t4 = _objectSpread;
               _context4.t5 = {};
-              if (!_this.config.permissionTokenRefresh) {
-                _context4.next = 15;
-                break;
-              }
-              _context4.next = 11;
-              return _this.getChannelToken();
-            case 11:
-              _context4.t7 = _context4.sent;
-              _context4.t6 = {
-                'x-token': _context4.t7
-              };
-              _context4.next = 16;
-              break;
-            case 15:
-              _context4.t6 = {};
-            case 16:
-              _context4.t8 = _context4.t6;
-              _context4.t9 = (0, _context4.t4)(_context4.t5, _context4.t8);
-              _context4.t10 = {};
-              _context4.t11 = {
-                'x-product': getProduct(_this.config.productInfo),
-                'x-subproduct': getSubProduct(_this.config.productInfo),
+              _context4.next = 10;
+              return _this.commonHeaders();
+            case 10:
+              _context4.t6 = _context4.sent;
+              _context4.t7 = (0, _context4.t4)(_context4.t5, _context4.t6);
+              _context4.t8 = {};
+              _context4.t9 = {
                 'Content-Type': 'application/json'
               };
-              _context4.t12 = (0, _context4.t3)(_context4.t9, _context4.t10, _context4.t11);
-              _context4.t13 = reqBody;
-              _context4.t14 = {
-                headers: _context4.t12,
+              _context4.t10 = (0, _context4.t3)(_context4.t7, _context4.t8, _context4.t9);
+              _context4.t11 = reqBody;
+              _context4.t12 = {
+                headers: _context4.t10,
                 method: 'POST',
-                body: _context4.t13
+                body: _context4.t11
               };
-              _context4.t15 = {
+              _context4.t13 = {
                 path: _context4.t2,
-                requestInit: _context4.t14
+                requestInit: _context4.t12
               };
-              _context4.next = 26;
-              return _context4.t0.requestService.call(_context4.t0, _context4.t1, _context4.t15);
-            case 26:
+              _context4.next = 20;
+              return _context4.t0.requestService.call(_context4.t0, _context4.t1, _context4.t13);
+            case 20:
               reconcileResponse = _context4.sent;
               return _context4.abrupt("return", reconcileResponse);
-            case 30:
-              _context4.prev = 30;
-              _context4.t16 = _context4["catch"](0);
-              (_this$analyticsHelper7 = _this.analyticsHelper) === null || _this$analyticsHelper7 === void 0 || _this$analyticsHelper7.sendErrorEvent(_context4.t16, 'Error while fetching reconciled document');
-              throw _context4.t16;
-            case 34:
+            case 24:
+              _context4.prev = 24;
+              _context4.t14 = _context4["catch"](0);
+              (_this$analyticsHelper7 = _this.analyticsHelper) === null || _this$analyticsHelper7 === void 0 || _this$analyticsHelper7.sendErrorEvent(_context4.t14, 'Error while fetching reconciled document');
+              throw _context4.t14;
+            case 28:
             case "end":
               return _context4.stop();
           }
-        }, _callee4, null, [[0, 30]]);
+        }, _callee4, null, [[0, 24]]);
       }));
       return function (_x6, _x7) {
         return _ref4.apply(this, arguments);
@@ -836,6 +775,51 @@ export var Channel = /*#__PURE__*/function (_Emitter) {
         _iterator.f();
       }
     }
+  }, {
+    key: "commonHeaders",
+    value: function () {
+      var _commonHeaders = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee8() {
+        return _regeneratorRuntime.wrap(function _callee8$(_context8) {
+          while (1) switch (_context8.prev = _context8.next) {
+            case 0:
+              _context8.t0 = _objectSpread;
+              _context8.t1 = _objectSpread;
+              _context8.t2 = {};
+              if (!this.config.permissionTokenRefresh) {
+                _context8.next = 10;
+                break;
+              }
+              _context8.next = 6;
+              return this.getChannelToken();
+            case 6:
+              _context8.t4 = _context8.sent;
+              _context8.t3 = {
+                'x-token': _context8.t4
+              };
+              _context8.next = 11;
+              break;
+            case 10:
+              _context8.t3 = {};
+            case 11:
+              _context8.t5 = _context8.t3;
+              _context8.t6 = (0, _context8.t1)(_context8.t2, _context8.t5);
+              _context8.t7 = {};
+              _context8.t8 = {
+                'x-product': getProduct(this.config.productInfo),
+                'x-subproduct': getSubProduct(this.config.productInfo)
+              };
+              return _context8.abrupt("return", (0, _context8.t0)(_context8.t6, _context8.t7, _context8.t8));
+            case 16:
+            case "end":
+              return _context8.stop();
+          }
+        }, _callee8, this);
+      }));
+      function commonHeaders() {
+        return _commonHeaders.apply(this, arguments);
+      }
+      return commonHeaders;
+    }()
   }, {
     key: "isLimitExceeded",
     value: function isLimitExceeded(stepLimit, stepSizeLimit, maxStepSizeLimit) {

package/dist/esm/document/catchupv2.js

@@ -1,7 +1,4 @@
 import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
-function _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e) { throw _e; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e2) { didErr = true; err = _e2; }, f: function f() { try { if (!normalCompletion && it.return != null) it.return(); } finally { if (didErr) throw err; } } }; }
-function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
-function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
 import _regeneratorRuntime from "@babel/runtime/regenerator";
 import { createLogger } from '../helpers/utils';
 var logger = createLogger('Catchupv2', 'red');
@@ -29,6 +26,13 @@ export var catchupv2 = /*#__PURE__*/function () {
           throw _context.t0;
         case 14:
           _context.prev = 14;
+          if (!(!steps || steps.length === 0)) {
+            _context.next = 18;
+            break;
+          }
+          opt.updateMetadata(metadata);
+          return _context.abrupt("return", false);
+        case 18:
           version = fromVersion + steps.length;
           stepsPayload = {
             version: version,
@@ -37,42 +41,36 @@ export var catchupv2 = /*#__PURE__*/function () {
           opt.onStepsAdded(stepsPayload);
           opt.updateMetadata(metadata);
           return _context.abrupt("return", Boolean(opt.clientId && isOutOfSync(fromVersion, opt.getCurrentPmVersion(), steps, opt.clientId)));
-        case 22:
-          _context.prev = 22;
+        case 25:
+          _context.prev = 25;
           _context.t1 = _context["catch"](14);
           (_opt$analyticsHelper2 = opt.analyticsHelper) === null || _opt$analyticsHelper2 === void 0 || _opt$analyticsHelper2.sendErrorEvent(_context.t1, 'Failed to apply catchupv2 result in the editor');
           logger("Apply catchupv2 steps failed:", _context.t1.message);
           throw _context.t1;
-        case 27:
+        case 30:
         case "end":
           return _context.stop();
       }
-    }, _callee, null, [[1, 9], [14, 22]]);
+    }, _callee, null, [[1, 9], [14, 25]]);
   }));
   return function catchupv2(_x) {
     return _ref.apply(this, arguments);
   };
 }();
-var isOutOfSync = function isOutOfSync(fromVersion, currentVersion, steps, clientId) {
+
+/**
+ * Checks if we're out of sync with the backend because catchup failed to apply, and thus the doc should be reset.
+ * @param fromVersion The document's PM version from before we applied catchup
+ * @param currentVersion The document's PM version after we applied catchup
+ * @param steps Steps returned to us by catchup
+ * @param clientId The ID of the currently connected session (one user can have multiple if theu have multiple tabs open)
+ * @returns True if we're out of sync, false if not.
+ */
+export var isOutOfSync = function isOutOfSync(fromVersion, currentVersion, steps, clientId) {
   return (
     // If version number hasn't increased, and steps are not from our client, we're out of sync
-    Boolean(fromVersion >= currentVersion && checkForeignSteps(steps, clientId))
+    Boolean(fromVersion >= currentVersion && steps.some(function (step) {
+      return step.clientId !== clientId;
+    }))
   );
-};
-var checkForeignSteps = function checkForeignSteps(steps, clientId) {
-  var _iterator = _createForOfIteratorHelper(steps),
-    _step;
-  try {
-    for (_iterator.s(); !(_step = _iterator.n()).done;) {
-      var step = _step.value;
-      if (step.clientId !== clientId) {
-        return true;
-      }
-    }
-  } catch (err) {
-    _iterator.e(err);
-  } finally {
-    _iterator.f();
-  }
-  return false;
 };

package/dist/esm/version-wrapper.js

@@ -1,5 +1,5 @@
 export var name = "@atlaskit/collab-provider";
-export var version = "9.26.4";
+export var version = "9.26.6";
 export var nextMajorVersion = function nextMajorVersion() {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

package/dist/types/channel.d.ts

@@ -32,6 +32,7 @@ export declare class Channel extends Emitter<ChannelEvent> {
      */
     connect(shouldInitialize?: boolean): void;
     onAnyOutgoingHandler(currentTimeMs: number, args: any[]): void;
+    private commonHeaders;
     private isLimitExceeded;
     private handlePermissionInvalidateToken;
     private onConnectError;

package/dist/types/document/catchupv2.d.ts

@@ -1,2 +1,12 @@
 import type { Catchupv2Options } from '../types';
+import type { StepJson } from '@atlaskit/editor-common/collab';
 export declare const catchupv2: (opt: Catchupv2Options) => Promise<boolean>;
+/**
+ * Checks if we're out of sync with the backend because catchup failed to apply, and thus the doc should be reset.
+ * @param fromVersion The document's PM version from before we applied catchup
+ * @param currentVersion The document's PM version after we applied catchup
+ * @param steps Steps returned to us by catchup
+ * @param clientId The ID of the currently connected session (one user can have multiple if theu have multiple tabs open)
+ * @returns True if we're out of sync, false if not.
+ */
+export declare const isOutOfSync: (fromVersion: number, currentVersion: number, steps: StepJson[], clientId: string | number) => boolean;

package/dist/types-ts4.5/channel.d.ts

@@ -32,6 +32,7 @@ export declare class Channel extends Emitter<ChannelEvent> {
      */
     connect(shouldInitialize?: boolean): void;
     onAnyOutgoingHandler(currentTimeMs: number, args: any[]): void;
+    private commonHeaders;
     private isLimitExceeded;
     private handlePermissionInvalidateToken;
     private onConnectError;

package/dist/types-ts4.5/document/catchupv2.d.ts

@@ -1,2 +1,12 @@
 import type { Catchupv2Options } from '../types';
+import type { StepJson } from '@atlaskit/editor-common/collab';
 export declare const catchupv2: (opt: Catchupv2Options) => Promise<boolean>;
+/**
+ * Checks if we're out of sync with the backend because catchup failed to apply, and thus the doc should be reset.
+ * @param fromVersion The document's PM version from before we applied catchup
+ * @param currentVersion The document's PM version after we applied catchup
+ * @param steps Steps returned to us by catchup
+ * @param clientId The ID of the currently connected session (one user can have multiple if theu have multiple tabs open)
+ * @returns True if we're out of sync, false if not.
+ */
+export declare const isOutOfSync: (fromVersion: number, currentVersion: number, steps: StepJson[], clientId: string | number) => boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/collab-provider",
-  "version": "9.26.4",
+  "version": "9.26.6",
   "description": "A provider for collaborative editing.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -39,7 +39,7 @@
   "dependencies": {
     "@atlaskit/analytics-gas-types": "^5.1.0",
     "@atlaskit/analytics-listeners": "^8.9.0",
-    "@atlaskit/editor-common": "^78.29.0",
+    "@atlaskit/editor-common": "^78.30.0",
     "@atlaskit/editor-json-transformer": "^8.10.0",
     "@atlaskit/editor-prosemirror": "3.0.0",
     "@atlaskit/platform-feature-flags": "^0.2.0",