@atlaskit/collab-provider 9.37.7 → 9.38.1

package/CHANGELOG.md

@@ -1,5 +1,26 @@
 # @atlaskit/collab-provider
 
+## 9.38.1
+
+### Patch Changes
+
+- [#136958](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/136958)
+  [`e1fd99410b2a7`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/e1fd99410b2a7) -
+  Adding reasons for BE catchup calls
+- Updated dependencies
+
+## 9.38.0
+
+### Minor Changes
+
+- [#137505](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/137505)
+  [`ed3b11d42c169`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/ed3b11d42c169) -
+  add ability to target a clientId for restore
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 9.37.7
 
 ### Patch Changes

package/dist/cjs/channel.js

@@ -305,7 +305,7 @@ var Channel = exports.Channel = /*#__PURE__*/function (_Emitter) {
       };
     }());
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "fetchCatchupv2", /*#__PURE__*/function () {
-      var _ref3 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3(fromVersion, clientId, catchUpOutofSync) {
+      var _ref3 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3(fromVersion, clientId, catchUpOutofSync, reason) {
         var _yield$utils$requestS2, steps, metadata, errorNotFound, errorCatchupv2;
         return _regenerator.default.wrap(function _callee3$(_context3) {
           while (1) switch (_context3.prev = _context3.next) {
@@ -317,7 +317,8 @@ var Channel = exports.Channel = /*#__PURE__*/function (_Emitter) {
               _context3.t3 = {
                 version: fromVersion,
                 clientId: clientId,
-                catchUpOutofSync: catchUpOutofSync
+                catchUpOutofSync: catchUpOutofSync,
+                reason: reason
               };
               _context3.next = 7;
               return _this.commonHeaders();
@@ -374,7 +375,7 @@ var Channel = exports.Channel = /*#__PURE__*/function (_Emitter) {
           }
         }, _callee3, null, [[0, 18]]);
       }));
-      return function (_x3, _x4, _x5) {
+      return function (_x3, _x4, _x5, _x6) {
         return _ref3.apply(this, arguments);
       };
     }());
@@ -432,7 +433,7 @@ var Channel = exports.Channel = /*#__PURE__*/function (_Emitter) {
           }
         }, _callee4, null, [[0, 24]]);
       }));
-      return function (_x6, _x7) {
+      return function (_x7, _x8) {
         return _ref4.apply(this, arguments);
       };
     }());
@@ -567,7 +568,7 @@ var Channel = exports.Channel = /*#__PURE__*/function (_Emitter) {
               }
             }, _callee5, null, [[1, 9]]);
           }));
-          return function auth(_x8) {
+          return function auth(_x9) {
             return _ref5.apply(this, arguments);
           };
         }();
@@ -592,7 +593,7 @@ var Channel = exports.Channel = /*#__PURE__*/function (_Emitter) {
               }
             }, _callee6);
           }));
-          return function auth(_x9) {
+          return function auth(_x10) {
             return _ref6.apply(this, arguments);
           };
         }();
@@ -687,7 +688,7 @@ var Channel = exports.Channel = /*#__PURE__*/function (_Emitter) {
             }
           }, _callee7);
         }));
-        return function (_x10) {
+        return function (_x11) {
           return _ref11.apply(this, arguments);
         };
       }());

package/dist/cjs/document/catchupv2.js

@@ -18,7 +18,7 @@ var catchupv2 = exports.catchupv2 = /*#__PURE__*/function () {
           fromVersion = opt.getCurrentPmVersion();
           _context.prev = 1;
           _context.next = 4;
-          return opt.fetchCatchupv2(fromVersion, opt.clientId, opt.catchUpOutofSync);
+          return opt.fetchCatchupv2(fromVersion, opt.clientId, opt.catchUpOutofSync, opt.reason);
         case 4:
           _yield$opt$fetchCatch = _context.sent;
           steps = _yield$opt$fetchCatch.steps;

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

@@ -129,9 +129,10 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
     })));
     /**
      * To prevent calling catchup to often, use lodash throttle to reduce the frequency
+     * @param reason - optional reason to attach.
      */
-    (0, _defineProperty2.default)(this, "throttledCatchupv2", (0, _throttle.default)(function () {
-      return _this.catchupv2();
+    (0, _defineProperty2.default)(this, "throttledCatchupv2", (0, _throttle.default)(function (reason) {
+      return _this.catchupv2(reason);
     }, CATCHUP_THROTTLE, {
       leading: false,
       // TODO: why shouldn't this be leading?
@@ -141,67 +142,74 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
      * Called when:
      *   * session established(offline -> online)
      *   * try to accept steps but version is behind.
+     * @param reason - optional reason to attach.
      */
-    (0, _defineProperty2.default)(this, "catchupv2", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2() {
-      var start, _this$analyticsHelper3, latency, _this$analyticsHelper4, _latency2;
-      return _regenerator.default.wrap(function _callee2$(_context2) {
-        while (1) switch (_context2.prev = _context2.next) {
-          case 0:
-            start = new Date().getTime(); // if the queue is already paused, we are busy with something else, so don't proceed.
-            if (!_this.stepQueue.isPaused()) {
-              _context2.next = 4;
-              break;
-            }
-            logger("Queue is paused. Aborting.");
-            return _context2.abrupt("return");
-          case 4:
-            if (!_this.isNameSpaceLocked()) {
-              _context2.next = 7;
+    (0, _defineProperty2.default)(this, "catchupv2", /*#__PURE__*/function () {
+      var _ref2 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(reason) {
+        var start, _this$analyticsHelper3, latency, _this$analyticsHelper4, _latency2;
+        return _regenerator.default.wrap(function _callee2$(_context2) {
+          while (1) switch (_context2.prev = _context2.next) {
+            case 0:
+              start = new Date().getTime(); // if the queue is already paused, we are busy with something else, so don't proceed.
+              if (!_this.stepQueue.isPaused()) {
+                _context2.next = 4;
+                break;
+              }
+              logger("Queue is paused. Aborting.");
+              return _context2.abrupt("return");
+            case 4:
+              if (!_this.isNameSpaceLocked()) {
+                _context2.next = 7;
+                break;
+              }
+              logger("catchupv2: Document is locked. Aborting.");
+              return _context2.abrupt("return");
+            case 7:
+              _this.stepQueue.pauseQueue();
+              _context2.prev = 8;
+              _context2.next = 11;
+              return (0, _catchupv.catchupv2)({
+                getCurrentPmVersion: _this.getCurrentPmVersion,
+                fetchCatchupv2: _this.fetchCatchupv2,
+                updateMetadata: _this.metadataService.updateMetadata,
+                analyticsHelper: _this.analyticsHelper,
+                clientId: _this.clientId,
+                onStepsAdded: _this.onStepsAdded,
+                catchUpOutofSync: _this.catchUpOutofSync,
+                reason: reason
+              });
+            case 11:
+              _this.catchUpOutofSync = _context2.sent;
+              latency = new Date().getTime() - start;
+              (_this$analyticsHelper3 = _this.analyticsHelper) === null || _this$analyticsHelper3 === void 0 || _this$analyticsHelper3.sendActionEvent(_const.EVENT_ACTION.CATCHUP, _const.EVENT_STATUS.SUCCESS, {
+                latency: latency
+              });
+              _context2.next = 20;
               break;
-            }
-            logger("catchupv2: Document is locked. Aborting.");
-            return _context2.abrupt("return");
-          case 7:
-            _this.stepQueue.pauseQueue();
-            _context2.prev = 8;
-            _context2.next = 11;
-            return (0, _catchupv.catchupv2)({
-              getCurrentPmVersion: _this.getCurrentPmVersion,
-              fetchCatchupv2: _this.fetchCatchupv2,
-              updateMetadata: _this.metadataService.updateMetadata,
-              analyticsHelper: _this.analyticsHelper,
-              clientId: _this.clientId,
-              onStepsAdded: _this.onStepsAdded,
-              catchUpOutofSync: _this.catchUpOutofSync
-            });
-          case 11:
-            _this.catchUpOutofSync = _context2.sent;
-            latency = new Date().getTime() - start;
-            (_this$analyticsHelper3 = _this.analyticsHelper) === null || _this$analyticsHelper3 === void 0 || _this$analyticsHelper3.sendActionEvent(_const.EVENT_ACTION.CATCHUP, _const.EVENT_STATUS.SUCCESS, {
-              latency: latency
-            });
-            _context2.next = 20;
-            break;
-          case 16:
-            _context2.prev = 16;
-            _context2.t0 = _context2["catch"](8);
-            _latency2 = new Date().getTime() - start;
-            (_this$analyticsHelper4 = _this.analyticsHelper) === null || _this$analyticsHelper4 === void 0 || _this$analyticsHelper4.sendActionEvent(_const.EVENT_ACTION.CATCHUP, _const.EVENT_STATUS.FAILURE, {
-              latency: _latency2
-            });
-          case 20:
-            _context2.prev = 20;
-            _this.stepQueue.resumeQueue();
-            _this.processQueue();
-            _this.sendStepsFromCurrentState(); // this will eventually retry catchup as it calls throttledCommitStep which will either catchup on onStepsAdded or onErrorHandled
-            _this.stepRejectCounter = 0;
-            return _context2.finish(20);
-          case 26:
-          case "end":
-            return _context2.stop();
-        }
-      }, _callee2, null, [[8, 16, 20, 26]]);
-    })));
+            case 16:
+              _context2.prev = 16;
+              _context2.t0 = _context2["catch"](8);
+              _latency2 = new Date().getTime() - start;
+              (_this$analyticsHelper4 = _this.analyticsHelper) === null || _this$analyticsHelper4 === void 0 || _this$analyticsHelper4.sendActionEvent(_const.EVENT_ACTION.CATCHUP, _const.EVENT_STATUS.FAILURE, {
+                latency: _latency2
+              });
+            case 20:
+              _context2.prev = 20;
+              _this.stepQueue.resumeQueue();
+              _this.processQueue();
+              _this.sendStepsFromCurrentState(); // this will eventually retry catchup as it calls throttledCommitStep which will either catchup on onStepsAdded or onErrorHandled
+              _this.stepRejectCounter = 0;
+              return _context2.finish(20);
+            case 26:
+            case "end":
+              return _context2.stop();
+          }
+        }, _callee2, null, [[8, 16, 20, 26]]);
+      }));
+      return function (_x) {
+        return _ref2.apply(this, arguments);
+      };
+    }());
     (0, _defineProperty2.default)(this, "getCurrentPmVersion", function () {
       var _this$getState;
       var state = (_this$getState = _this.getState) === null || _this$getState === void 0 ? void 0 : _this$getState.call(_this);
@@ -299,7 +307,7 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
         } else if (data.version > expectedVersion) {
           logger("Version too high. Expected \"".concat(expectedVersion, "\" but got \"").concat(data.version, ". Current local version is ").concat(currentVersion, "."));
           _this.stepQueue.queueSteps(data);
-          _this.throttledCatchupv2();
+          _this.throttledCatchupv2(_const.CatchupEventReason.STEPS_ADDED);
         }
         _this.participantsService.updateLastActive(data.steps.map(function (_ref4) {
           var userId = _ref4.userId;
@@ -321,20 +329,26 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
     // Triggered when page recovery has emitted an 'init' event on a page client is currently connected to.
     (0, _defineProperty2.default)(this, "onRestore", /*#__PURE__*/function () {
       var _ref6 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4(_ref5) {
-        var doc, version, metadata, unconfirmedSteps, currentState, useReconcile, _this$analyticsHelper13, _this$analyticsHelper14, _this$analyticsHelper15;
+        var doc, version, metadata, targetClientId, unconfirmedSteps, currentState, useReconcile, _this$analyticsHelper13, _this$analyticsHelper14, _this$analyticsHelper15;
         return _regenerator.default.wrap(function _callee4$(_context4) {
           while (1) switch (_context4.prev = _context4.next) {
             case 0:
-              doc = _ref5.doc, version = _ref5.version, metadata = _ref5.metadata;
+              doc = _ref5.doc, version = _ref5.version, metadata = _ref5.metadata, targetClientId = _ref5.targetClientId;
+              if (!(targetClientId && _this.clientId !== targetClientId)) {
+                _context4.next = 3;
+                break;
+              }
+              return _context4.abrupt("return");
+            case 3:
               // We preserve these as they will be lost apon this.updateDocument. This is because we are using document recovery.
               // We can then reconcile the document with the preserved state.
               unconfirmedSteps = _this.getUnconfirmedSteps();
-              _context4.next = 4;
+              _context4.next = 6;
               return _this.getCurrentState();
-            case 4:
+            case 6:
               currentState = _context4.sent;
               useReconcile = Boolean((unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length) && currentState);
-              _context4.prev = 6;
+              _context4.prev = 8;
               // Reset the editor,
               //  - Replace the document, keep in sync with the server
               //  - Replace the version number, so editor is in sync with NCS server and can commit new changes.
@@ -351,29 +365,29 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
 
               // If there are unconfirmed steps, attempt to reconcile our current state with with recovered document
               if (!(useReconcile && currentState)) {
-                _context4.next = 14;
+                _context4.next = 16;
                 break;
               }
-              _context4.next = 12;
+              _context4.next = 14;
               return _this.fetchReconcile(JSON.stringify(currentState.content), 'fe-restore');
-            case 12:
-              _context4.next = 15;
-              break;
             case 14:
+              _context4.next = 17;
+              break;
+            case 16:
               if (unconfirmedSteps !== null && unconfirmedSteps !== void 0 && unconfirmedSteps.length) {
                 _this.applyLocalSteps(unconfirmedSteps);
               }
-            case 15:
+            case 17:
               (_this$analyticsHelper13 = _this.analyticsHelper) === null || _this$analyticsHelper13 === void 0 || _this$analyticsHelper13.sendActionEvent(_const.EVENT_ACTION.REINITIALISE_DOCUMENT, _const.EVENT_STATUS.SUCCESS, {
                 numUnconfirmedSteps: unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length,
                 hasTitle: !!(metadata !== null && metadata !== void 0 && metadata.title),
                 useReconcile: useReconcile
               });
-              _context4.next = 23;
+              _context4.next = 25;
               break;
-            case 18:
-              _context4.prev = 18;
-              _context4.t0 = _context4["catch"](6);
+            case 20:
+              _context4.prev = 20;
+              _context4.t0 = _context4["catch"](8);
               (_this$analyticsHelper14 = _this.analyticsHelper) === null || _this$analyticsHelper14 === void 0 || _this$analyticsHelper14.sendActionEvent(_const.EVENT_ACTION.REINITIALISE_DOCUMENT, _const.EVENT_STATUS.FAILURE, {
                 numUnconfirmedSteps: unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length,
                 useReconcile: useReconcile
@@ -387,13 +401,13 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
                   code: _internalErrors.INTERNAL_ERROR_CODE.DOCUMENT_RESTORE_ERROR
                 }
               });
-            case 23:
+            case 25:
             case "end":
               return _context4.stop();
           }
-        }, _callee4, null, [[6, 18]]);
+        }, _callee4, null, [[8, 20]]);
       }));
-      return function (_x) {
+      return function (_x2) {
         return _ref6.apply(this, arguments);
       };
     }());
@@ -638,7 +652,7 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
         var _this$analyticsHelper27;
         logger("The steps were rejected too many times (tries=".concat(_this.stepRejectCounter, ", limit=").concat(_provider.MAX_STEP_REJECTED_ERROR, "). Trying to catch-up."));
         (_this$analyticsHelper27 = _this.analyticsHelper) === null || _this$analyticsHelper27 === void 0 || _this$analyticsHelper27.sendActionEvent(_const.EVENT_ACTION.CATCHUP_AFTER_MAX_SEND_STEPS_RETRY, _const.EVENT_STATUS.INFO);
-        _this.throttledCatchupv2();
+        _this.throttledCatchupv2(_const.CatchupEventReason.STEPS_REJECTED);
       } else {
         // If committing steps failed try again automatically in 1s
         // This makes it more likely that unconfirmed steps trigger a catch-up
@@ -716,7 +730,7 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
           var _this$analyticsHelper28;
           logger("Processing steps failed with error: ".concat(error, ". Triggering catch up call."));
           (_this$analyticsHelper28 = this.analyticsHelper) === null || _this$analyticsHelper28 === void 0 || _this$analyticsHelper28.sendErrorEvent(error, 'Error while processing steps');
-          this.throttledCatchupv2();
+          this.throttledCatchupv2(_const.CatchupEventReason.PROCESS_STEPS);
         }
       }
     }

package/dist/cjs/helpers/const.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.EVENT_STATUS = exports.EVENT_ACTION = exports.CONFLUENCE = exports.ADD_STEPS_TYPE = exports.ACK_MAX_TRY = void 0;
+exports.EVENT_STATUS = exports.EVENT_ACTION = exports.CatchupEventReason = exports.CONFLUENCE = exports.ADD_STEPS_TYPE = exports.ACK_MAX_TRY = void 0;
 var EVENT_ACTION = exports.EVENT_ACTION = /*#__PURE__*/function (EVENT_ACTION) {
   EVENT_ACTION["CONNECTION"] = "connection";
   EVENT_ACTION["CATCHUP"] = "catchup";
@@ -40,4 +40,13 @@ var ADD_STEPS_TYPE = exports.ADD_STEPS_TYPE = /*#__PURE__*/function (ADD_STEPS_T
   return ADD_STEPS_TYPE;
 }({});
 var ACK_MAX_TRY = exports.ACK_MAX_TRY = 60;
-var CONFLUENCE = exports.CONFLUENCE = 'confluence';
+var CONFLUENCE = exports.CONFLUENCE = 'confluence';
+
+/** Enumerable for attaching a reason to catchup (v2) call(s) */
+var CatchupEventReason = exports.CatchupEventReason = /*#__PURE__*/function (CatchupEventReason) {
+  CatchupEventReason["STEPS_ADDED"] = "onStepsAdded";
+  CatchupEventReason["STEPS_REJECTED"] = "onStepsRejected";
+  CatchupEventReason["PROCESS_STEPS"] = "processSteps";
+  CatchupEventReason["RECONNECTED"] = "reconnected";
+  return CatchupEventReason;
+}({});

package/dist/cjs/provider/index.js

@@ -135,7 +135,7 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
         if (initialized && _this.disconnectedAt &&
         // Offline longer than `OUT_OF_SYNC_PERIOD`
         Date.now() - _this.disconnectedAt >= OUT_OF_SYNC_PERIOD) {
-          _this.documentService.throttledCatchupv2();
+          _this.documentService.throttledCatchupv2(_const.CatchupEventReason.RECONNECTED);
         }
         _this.participantsService.startInactiveRemover(_this.sessionId);
         _this.disconnectedAt = undefined;

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.37.7";
+var version = exports.version = "9.38.1";
 var nextMajorVersion = exports.nextMajorVersion = function nextMajorVersion() {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

package/dist/es2019/channel.js

@@ -209,7 +209,7 @@ export class Channel extends Emitter {
         throw error;
       }
     });
-    _defineProperty(this, "fetchCatchupv2", async (fromVersion, clientId, catchUpOutofSync) => {
+    _defineProperty(this, "fetchCatchupv2", async (fromVersion, clientId, catchUpOutofSync, reason) => {
       try {
         const {
           steps,
@@ -219,7 +219,8 @@ export class Channel extends Emitter {
           queryParams: {
             version: fromVersion,
             clientId: clientId,
-            catchUpOutofSync
+            catchUpOutofSync,
+            reason
           },
           requestInit: {
             headers: await this.commonHeaders()

package/dist/es2019/document/catchupv2.js

@@ -8,7 +8,7 @@ export const catchupv2 = async opt => {
     ({
       steps,
       metadata
-    } = await opt.fetchCatchupv2(fromVersion, opt.clientId, opt.catchUpOutofSync));
+    } = await opt.fetchCatchupv2(fromVersion, opt.clientId, opt.catchUpOutofSync, opt.reason));
   } catch (error) {
     var _opt$analyticsHelper;
     (_opt$analyticsHelper = opt.analyticsHelper) === null || _opt$analyticsHelper === void 0 ? void 0 : _opt$analyticsHelper.sendErrorEvent(error, 'Error while fetching catchupv2 from server');

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

@@ -1,5 +1,5 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
-import { ACK_MAX_TRY, EVENT_ACTION, EVENT_STATUS } from '../helpers/const';
+import { ACK_MAX_TRY, EVENT_ACTION, EVENT_STATUS, CatchupEventReason } from '../helpers/const';
 import { getVersion, sendableSteps } from '@atlaskit/prosemirror-collab';
 import { JSONTransformer } from '@atlaskit/editor-json-transformer';
 import throttle from 'lodash/throttle';
@@ -94,8 +94,9 @@ export class DocumentService {
     });
     /**
      * To prevent calling catchup to often, use lodash throttle to reduce the frequency
+     * @param reason - optional reason to attach.
      */
-    _defineProperty(this, "throttledCatchupv2", throttle(() => this.catchupv2(), CATCHUP_THROTTLE, {
+    _defineProperty(this, "throttledCatchupv2", throttle(reason => this.catchupv2(reason), CATCHUP_THROTTLE, {
       leading: false,
       // TODO: why shouldn't this be leading?
       trailing: true
@@ -104,8 +105,9 @@ export class DocumentService {
      * Called when:
      *   * session established(offline -> online)
      *   * try to accept steps but version is behind.
+     * @param reason - optional reason to attach.
      */
-    _defineProperty(this, "catchupv2", async () => {
+    _defineProperty(this, "catchupv2", async reason => {
       const start = new Date().getTime();
       // if the queue is already paused, we are busy with something else, so don't proceed.
       if (this.stepQueue.isPaused()) {
@@ -149,7 +151,8 @@ export class DocumentService {
           analyticsHelper: this.analyticsHelper,
           clientId: this.clientId,
           onStepsAdded: this.onStepsAdded,
-          catchUpOutofSync: this.catchUpOutofSync
+          catchUpOutofSync: this.catchUpOutofSync,
+          reason
         });
         const latency = new Date().getTime() - start;
         (_this$analyticsHelper3 = this.analyticsHelper) === null || _this$analyticsHelper3 === void 0 ? void 0 : _this$analyticsHelper3.sendActionEvent(EVENT_ACTION.CATCHUP, EVENT_STATUS.SUCCESS, {
@@ -258,7 +261,7 @@ export class DocumentService {
         } else if (data.version > expectedVersion) {
           logger(`Version too high. Expected "${expectedVersion}" but got "${data.version}. Current local version is ${currentVersion}.`);
           this.stepQueue.queueSteps(data);
-          this.throttledCatchupv2();
+          this.throttledCatchupv2(CatchupEventReason.STEPS_ADDED);
         }
         this.participantsService.updateLastActive(data.steps.map(({
           userId
@@ -280,8 +283,12 @@ export class DocumentService {
     _defineProperty(this, "onRestore", async ({
       doc,
       version,
-      metadata
+      metadata,
+      targetClientId
     }) => {
+      if (targetClientId && this.clientId !== targetClientId) {
+        return;
+      }
       // We preserve these as they will be lost apon this.updateDocument. This is because we are using document recovery.
       // We can then reconcile the document with the preserved state.
       const unconfirmedSteps = this.getUnconfirmedSteps();
@@ -526,7 +533,7 @@ export class DocumentService {
         var _this$analyticsHelper27;
         logger(`The steps were rejected too many times (tries=${this.stepRejectCounter}, limit=${MAX_STEP_REJECTED_ERROR}). Trying to catch-up.`);
         (_this$analyticsHelper27 = this.analyticsHelper) === null || _this$analyticsHelper27 === void 0 ? void 0 : _this$analyticsHelper27.sendActionEvent(EVENT_ACTION.CATCHUP_AFTER_MAX_SEND_STEPS_RETRY, EVENT_STATUS.INFO);
-        this.throttledCatchupv2();
+        this.throttledCatchupv2(CatchupEventReason.STEPS_REJECTED);
       } else {
         // If committing steps failed try again automatically in 1s
         // This makes it more likely that unconfirmed steps trigger a catch-up
@@ -596,7 +603,7 @@ export class DocumentService {
         var _this$analyticsHelper28;
         logger(`Processing steps failed with error: ${error}. Triggering catch up call.`);
         (_this$analyticsHelper28 = this.analyticsHelper) === null || _this$analyticsHelper28 === void 0 ? void 0 : _this$analyticsHelper28.sendErrorEvent(error, 'Error while processing steps');
-        this.throttledCatchupv2();
+        this.throttledCatchupv2(CatchupEventReason.PROCESS_STEPS);
       }
     }
   }

package/dist/es2019/helpers/const.js

@@ -34,4 +34,13 @@ export let ADD_STEPS_TYPE = /*#__PURE__*/function (ADD_STEPS_TYPE) {
   return ADD_STEPS_TYPE;
 }({});
 export const ACK_MAX_TRY = 60;
-export const CONFLUENCE = 'confluence';
+export const CONFLUENCE = 'confluence';
+
+/** Enumerable for attaching a reason to catchup (v2) call(s) */
+export let CatchupEventReason = /*#__PURE__*/function (CatchupEventReason) {
+  CatchupEventReason["STEPS_ADDED"] = "onStepsAdded";
+  CatchupEventReason["STEPS_REJECTED"] = "onStepsRejected";
+  CatchupEventReason["PROCESS_STEPS"] = "processSteps";
+  CatchupEventReason["RECONNECTED"] = "reconnected";
+  return CatchupEventReason;
+}({});

package/dist/es2019/provider/index.js

@@ -13,7 +13,7 @@ import { NamespaceService } from '../namespace/namespace-service';
 import { ParticipantsService } from '../participants/participants-service';
 import { errorCodeMapper } from '../errors/error-code-mapper';
 import { INTERNAL_ERROR_CODE } from '../errors/internal-errors';
-import { EVENT_ACTION, EVENT_STATUS } from '../helpers/const';
+import { EVENT_ACTION, EVENT_STATUS, CatchupEventReason } from '../helpers/const';
 import { getCollabProviderFeatureFlag } from '../feature-flags';
 import { Api } from '../api/api';
 import { shouldTelepointerBeSampled } from '../analytics/performance';
@@ -112,7 +112,7 @@ export class Provider extends Emitter {
         if (initialized && this.disconnectedAt &&
         // Offline longer than `OUT_OF_SYNC_PERIOD`
         Date.now() - this.disconnectedAt >= OUT_OF_SYNC_PERIOD) {
-          this.documentService.throttledCatchupv2();
+          this.documentService.throttledCatchupv2(CatchupEventReason.RECONNECTED);
         }
         this.participantsService.startInactiveRemover(this.sessionId);
         this.disconnectedAt = undefined;

package/dist/es2019/version-wrapper.js

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

package/dist/esm/channel.js

@@ -298,7 +298,7 @@ export var Channel = /*#__PURE__*/function (_Emitter) {
       };
     }());
     _defineProperty(_assertThisInitialized(_this), "fetchCatchupv2", /*#__PURE__*/function () {
-      var _ref3 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee3(fromVersion, clientId, catchUpOutofSync) {
+      var _ref3 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee3(fromVersion, clientId, catchUpOutofSync, reason) {
         var _yield$utils$requestS2, steps, metadata, errorNotFound, errorCatchupv2;
         return _regeneratorRuntime.wrap(function _callee3$(_context3) {
           while (1) switch (_context3.prev = _context3.next) {
@@ -310,7 +310,8 @@ export var Channel = /*#__PURE__*/function (_Emitter) {
               _context3.t3 = {
                 version: fromVersion,
                 clientId: clientId,
-                catchUpOutofSync: catchUpOutofSync
+                catchUpOutofSync: catchUpOutofSync,
+                reason: reason
               };
               _context3.next = 7;
               return _this.commonHeaders();
@@ -367,7 +368,7 @@ export var Channel = /*#__PURE__*/function (_Emitter) {
           }
         }, _callee3, null, [[0, 18]]);
       }));
-      return function (_x3, _x4, _x5) {
+      return function (_x3, _x4, _x5, _x6) {
         return _ref3.apply(this, arguments);
       };
     }());
@@ -425,7 +426,7 @@ export var Channel = /*#__PURE__*/function (_Emitter) {
           }
         }, _callee4, null, [[0, 24]]);
       }));
-      return function (_x6, _x7) {
+      return function (_x7, _x8) {
         return _ref4.apply(this, arguments);
       };
     }());
@@ -560,7 +561,7 @@ export var Channel = /*#__PURE__*/function (_Emitter) {
               }
             }, _callee5, null, [[1, 9]]);
           }));
-          return function auth(_x8) {
+          return function auth(_x9) {
             return _ref5.apply(this, arguments);
           };
         }();
@@ -585,7 +586,7 @@ export var Channel = /*#__PURE__*/function (_Emitter) {
               }
             }, _callee6);
           }));
-          return function auth(_x9) {
+          return function auth(_x10) {
             return _ref6.apply(this, arguments);
           };
         }();
@@ -680,7 +681,7 @@ export var Channel = /*#__PURE__*/function (_Emitter) {
             }
           }, _callee7);
         }));
-        return function (_x10) {
+        return function (_x11) {
           return _ref11.apply(this, arguments);
         };
       }());

package/dist/esm/document/catchupv2.js

@@ -11,7 +11,7 @@ export var catchupv2 = /*#__PURE__*/function () {
           fromVersion = opt.getCurrentPmVersion();
           _context.prev = 1;
           _context.next = 4;
-          return opt.fetchCatchupv2(fromVersion, opt.clientId, opt.catchUpOutofSync);
+          return opt.fetchCatchupv2(fromVersion, opt.clientId, opt.catchUpOutofSync, opt.reason);
         case 4:
           _yield$opt$fetchCatch = _context.sent;
           steps = _yield$opt$fetchCatch.steps;

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

@@ -5,7 +5,7 @@ import _defineProperty from "@babel/runtime/helpers/defineProperty";
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 import _regeneratorRuntime from "@babel/runtime/regenerator";
-import { ACK_MAX_TRY, EVENT_ACTION, EVENT_STATUS } from '../helpers/const';
+import { ACK_MAX_TRY, EVENT_ACTION, EVENT_STATUS, CatchupEventReason } from '../helpers/const';
 import { getVersion, sendableSteps } from '@atlaskit/prosemirror-collab';
 import { JSONTransformer } from '@atlaskit/editor-json-transformer';
 import throttle from 'lodash/throttle';
@@ -122,9 +122,10 @@ export var DocumentService = /*#__PURE__*/function () {
     })));
     /**
      * To prevent calling catchup to often, use lodash throttle to reduce the frequency
+     * @param reason - optional reason to attach.
      */
-    _defineProperty(this, "throttledCatchupv2", throttle(function () {
-      return _this.catchupv2();
+    _defineProperty(this, "throttledCatchupv2", throttle(function (reason) {
+      return _this.catchupv2(reason);
     }, CATCHUP_THROTTLE, {
       leading: false,
       // TODO: why shouldn't this be leading?
@@ -134,67 +135,74 @@ export var DocumentService = /*#__PURE__*/function () {
      * Called when:
      *   * session established(offline -> online)
      *   * try to accept steps but version is behind.
+     * @param reason - optional reason to attach.
      */
-    _defineProperty(this, "catchupv2", /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2() {
-      var start, _this$analyticsHelper3, latency, _this$analyticsHelper4, _latency2;
-      return _regeneratorRuntime.wrap(function _callee2$(_context2) {
-        while (1) switch (_context2.prev = _context2.next) {
-          case 0:
-            start = new Date().getTime(); // if the queue is already paused, we are busy with something else, so don't proceed.
-            if (!_this.stepQueue.isPaused()) {
-              _context2.next = 4;
-              break;
-            }
-            logger("Queue is paused. Aborting.");
-            return _context2.abrupt("return");
-          case 4:
-            if (!_this.isNameSpaceLocked()) {
-              _context2.next = 7;
+    _defineProperty(this, "catchupv2", /*#__PURE__*/function () {
+      var _ref2 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2(reason) {
+        var start, _this$analyticsHelper3, latency, _this$analyticsHelper4, _latency2;
+        return _regeneratorRuntime.wrap(function _callee2$(_context2) {
+          while (1) switch (_context2.prev = _context2.next) {
+            case 0:
+              start = new Date().getTime(); // if the queue is already paused, we are busy with something else, so don't proceed.
+              if (!_this.stepQueue.isPaused()) {
+                _context2.next = 4;
+                break;
+              }
+              logger("Queue is paused. Aborting.");
+              return _context2.abrupt("return");
+            case 4:
+              if (!_this.isNameSpaceLocked()) {
+                _context2.next = 7;
+                break;
+              }
+              logger("catchupv2: Document is locked. Aborting.");
+              return _context2.abrupt("return");
+            case 7:
+              _this.stepQueue.pauseQueue();
+              _context2.prev = 8;
+              _context2.next = 11;
+              return catchupv2({
+                getCurrentPmVersion: _this.getCurrentPmVersion,
+                fetchCatchupv2: _this.fetchCatchupv2,
+                updateMetadata: _this.metadataService.updateMetadata,
+                analyticsHelper: _this.analyticsHelper,
+                clientId: _this.clientId,
+                onStepsAdded: _this.onStepsAdded,
+                catchUpOutofSync: _this.catchUpOutofSync,
+                reason: reason
+              });
+            case 11:
+              _this.catchUpOutofSync = _context2.sent;
+              latency = new Date().getTime() - start;
+              (_this$analyticsHelper3 = _this.analyticsHelper) === null || _this$analyticsHelper3 === void 0 || _this$analyticsHelper3.sendActionEvent(EVENT_ACTION.CATCHUP, EVENT_STATUS.SUCCESS, {
+                latency: latency
+              });
+              _context2.next = 20;
               break;
-            }
-            logger("catchupv2: Document is locked. Aborting.");
-            return _context2.abrupt("return");
-          case 7:
-            _this.stepQueue.pauseQueue();
-            _context2.prev = 8;
-            _context2.next = 11;
-            return catchupv2({
-              getCurrentPmVersion: _this.getCurrentPmVersion,
-              fetchCatchupv2: _this.fetchCatchupv2,
-              updateMetadata: _this.metadataService.updateMetadata,
-              analyticsHelper: _this.analyticsHelper,
-              clientId: _this.clientId,
-              onStepsAdded: _this.onStepsAdded,
-              catchUpOutofSync: _this.catchUpOutofSync
-            });
-          case 11:
-            _this.catchUpOutofSync = _context2.sent;
-            latency = new Date().getTime() - start;
-            (_this$analyticsHelper3 = _this.analyticsHelper) === null || _this$analyticsHelper3 === void 0 || _this$analyticsHelper3.sendActionEvent(EVENT_ACTION.CATCHUP, EVENT_STATUS.SUCCESS, {
-              latency: latency
-            });
-            _context2.next = 20;
-            break;
-          case 16:
-            _context2.prev = 16;
-            _context2.t0 = _context2["catch"](8);
-            _latency2 = new Date().getTime() - start;
-            (_this$analyticsHelper4 = _this.analyticsHelper) === null || _this$analyticsHelper4 === void 0 || _this$analyticsHelper4.sendActionEvent(EVENT_ACTION.CATCHUP, EVENT_STATUS.FAILURE, {
-              latency: _latency2
-            });
-          case 20:
-            _context2.prev = 20;
-            _this.stepQueue.resumeQueue();
-            _this.processQueue();
-            _this.sendStepsFromCurrentState(); // this will eventually retry catchup as it calls throttledCommitStep which will either catchup on onStepsAdded or onErrorHandled
-            _this.stepRejectCounter = 0;
-            return _context2.finish(20);
-          case 26:
-          case "end":
-            return _context2.stop();
-        }
-      }, _callee2, null, [[8, 16, 20, 26]]);
-    })));
+            case 16:
+              _context2.prev = 16;
+              _context2.t0 = _context2["catch"](8);
+              _latency2 = new Date().getTime() - start;
+              (_this$analyticsHelper4 = _this.analyticsHelper) === null || _this$analyticsHelper4 === void 0 || _this$analyticsHelper4.sendActionEvent(EVENT_ACTION.CATCHUP, EVENT_STATUS.FAILURE, {
+                latency: _latency2
+              });
+            case 20:
+              _context2.prev = 20;
+              _this.stepQueue.resumeQueue();
+              _this.processQueue();
+              _this.sendStepsFromCurrentState(); // this will eventually retry catchup as it calls throttledCommitStep which will either catchup on onStepsAdded or onErrorHandled
+              _this.stepRejectCounter = 0;
+              return _context2.finish(20);
+            case 26:
+            case "end":
+              return _context2.stop();
+          }
+        }, _callee2, null, [[8, 16, 20, 26]]);
+      }));
+      return function (_x) {
+        return _ref2.apply(this, arguments);
+      };
+    }());
     _defineProperty(this, "getCurrentPmVersion", function () {
       var _this$getState;
       var state = (_this$getState = _this.getState) === null || _this$getState === void 0 ? void 0 : _this$getState.call(_this);
@@ -292,7 +300,7 @@ export var DocumentService = /*#__PURE__*/function () {
         } else if (data.version > expectedVersion) {
           logger("Version too high. Expected \"".concat(expectedVersion, "\" but got \"").concat(data.version, ". Current local version is ").concat(currentVersion, "."));
           _this.stepQueue.queueSteps(data);
-          _this.throttledCatchupv2();
+          _this.throttledCatchupv2(CatchupEventReason.STEPS_ADDED);
         }
         _this.participantsService.updateLastActive(data.steps.map(function (_ref4) {
           var userId = _ref4.userId;
@@ -314,20 +322,26 @@ export var DocumentService = /*#__PURE__*/function () {
     // Triggered when page recovery has emitted an 'init' event on a page client is currently connected to.
     _defineProperty(this, "onRestore", /*#__PURE__*/function () {
       var _ref6 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee4(_ref5) {
-        var doc, version, metadata, unconfirmedSteps, currentState, useReconcile, _this$analyticsHelper13, _this$analyticsHelper14, _this$analyticsHelper15;
+        var doc, version, metadata, targetClientId, unconfirmedSteps, currentState, useReconcile, _this$analyticsHelper13, _this$analyticsHelper14, _this$analyticsHelper15;
         return _regeneratorRuntime.wrap(function _callee4$(_context4) {
           while (1) switch (_context4.prev = _context4.next) {
             case 0:
-              doc = _ref5.doc, version = _ref5.version, metadata = _ref5.metadata;
+              doc = _ref5.doc, version = _ref5.version, metadata = _ref5.metadata, targetClientId = _ref5.targetClientId;
+              if (!(targetClientId && _this.clientId !== targetClientId)) {
+                _context4.next = 3;
+                break;
+              }
+              return _context4.abrupt("return");
+            case 3:
               // We preserve these as they will be lost apon this.updateDocument. This is because we are using document recovery.
               // We can then reconcile the document with the preserved state.
               unconfirmedSteps = _this.getUnconfirmedSteps();
-              _context4.next = 4;
+              _context4.next = 6;
               return _this.getCurrentState();
-            case 4:
+            case 6:
               currentState = _context4.sent;
               useReconcile = Boolean((unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length) && currentState);
-              _context4.prev = 6;
+              _context4.prev = 8;
               // Reset the editor,
               //  - Replace the document, keep in sync with the server
               //  - Replace the version number, so editor is in sync with NCS server and can commit new changes.
@@ -344,29 +358,29 @@ export var DocumentService = /*#__PURE__*/function () {
 
               // If there are unconfirmed steps, attempt to reconcile our current state with with recovered document
               if (!(useReconcile && currentState)) {
-                _context4.next = 14;
+                _context4.next = 16;
                 break;
               }
-              _context4.next = 12;
+              _context4.next = 14;
               return _this.fetchReconcile(JSON.stringify(currentState.content), 'fe-restore');
-            case 12:
-              _context4.next = 15;
-              break;
             case 14:
+              _context4.next = 17;
+              break;
+            case 16:
               if (unconfirmedSteps !== null && unconfirmedSteps !== void 0 && unconfirmedSteps.length) {
                 _this.applyLocalSteps(unconfirmedSteps);
               }
-            case 15:
+            case 17:
               (_this$analyticsHelper13 = _this.analyticsHelper) === null || _this$analyticsHelper13 === void 0 || _this$analyticsHelper13.sendActionEvent(EVENT_ACTION.REINITIALISE_DOCUMENT, EVENT_STATUS.SUCCESS, {
                 numUnconfirmedSteps: unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length,
                 hasTitle: !!(metadata !== null && metadata !== void 0 && metadata.title),
                 useReconcile: useReconcile
               });
-              _context4.next = 23;
+              _context4.next = 25;
               break;
-            case 18:
-              _context4.prev = 18;
-              _context4.t0 = _context4["catch"](6);
+            case 20:
+              _context4.prev = 20;
+              _context4.t0 = _context4["catch"](8);
               (_this$analyticsHelper14 = _this.analyticsHelper) === null || _this$analyticsHelper14 === void 0 || _this$analyticsHelper14.sendActionEvent(EVENT_ACTION.REINITIALISE_DOCUMENT, EVENT_STATUS.FAILURE, {
                 numUnconfirmedSteps: unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length,
                 useReconcile: useReconcile
@@ -380,13 +394,13 @@ export var DocumentService = /*#__PURE__*/function () {
                   code: INTERNAL_ERROR_CODE.DOCUMENT_RESTORE_ERROR
                 }
               });
-            case 23:
+            case 25:
             case "end":
               return _context4.stop();
           }
-        }, _callee4, null, [[6, 18]]);
+        }, _callee4, null, [[8, 20]]);
       }));
-      return function (_x) {
+      return function (_x2) {
         return _ref6.apply(this, arguments);
       };
     }());
@@ -631,7 +645,7 @@ export var DocumentService = /*#__PURE__*/function () {
         var _this$analyticsHelper27;
         logger("The steps were rejected too many times (tries=".concat(_this.stepRejectCounter, ", limit=").concat(MAX_STEP_REJECTED_ERROR, "). Trying to catch-up."));
         (_this$analyticsHelper27 = _this.analyticsHelper) === null || _this$analyticsHelper27 === void 0 || _this$analyticsHelper27.sendActionEvent(EVENT_ACTION.CATCHUP_AFTER_MAX_SEND_STEPS_RETRY, EVENT_STATUS.INFO);
-        _this.throttledCatchupv2();
+        _this.throttledCatchupv2(CatchupEventReason.STEPS_REJECTED);
       } else {
         // If committing steps failed try again automatically in 1s
         // This makes it more likely that unconfirmed steps trigger a catch-up
@@ -709,7 +723,7 @@ export var DocumentService = /*#__PURE__*/function () {
           var _this$analyticsHelper28;
           logger("Processing steps failed with error: ".concat(error, ". Triggering catch up call."));
           (_this$analyticsHelper28 = this.analyticsHelper) === null || _this$analyticsHelper28 === void 0 || _this$analyticsHelper28.sendErrorEvent(error, 'Error while processing steps');
-          this.throttledCatchupv2();
+          this.throttledCatchupv2(CatchupEventReason.PROCESS_STEPS);
         }
       }
     }

package/dist/esm/helpers/const.js

@@ -34,4 +34,13 @@ export var ADD_STEPS_TYPE = /*#__PURE__*/function (ADD_STEPS_TYPE) {
   return ADD_STEPS_TYPE;
 }({});
 export var ACK_MAX_TRY = 60;
-export var CONFLUENCE = 'confluence';
+export var CONFLUENCE = 'confluence';
+
+/** Enumerable for attaching a reason to catchup (v2) call(s) */
+export var CatchupEventReason = /*#__PURE__*/function (CatchupEventReason) {
+  CatchupEventReason["STEPS_ADDED"] = "onStepsAdded";
+  CatchupEventReason["STEPS_REJECTED"] = "onStepsRejected";
+  CatchupEventReason["PROCESS_STEPS"] = "processSteps";
+  CatchupEventReason["RECONNECTED"] = "reconnected";
+  return CatchupEventReason;
+}({});

package/dist/esm/provider/index.js

@@ -26,7 +26,7 @@ import { NamespaceService } from '../namespace/namespace-service';
 import { ParticipantsService } from '../participants/participants-service';
 import { errorCodeMapper } from '../errors/error-code-mapper';
 import { INTERNAL_ERROR_CODE } from '../errors/internal-errors';
-import { EVENT_ACTION, EVENT_STATUS } from '../helpers/const';
+import { EVENT_ACTION, EVENT_STATUS, CatchupEventReason } from '../helpers/const';
 import { getCollabProviderFeatureFlag } from '../feature-flags';
 import { Api } from '../api/api';
 import { shouldTelepointerBeSampled } from '../analytics/performance';
@@ -128,7 +128,7 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
         if (initialized && _this.disconnectedAt &&
         // Offline longer than `OUT_OF_SYNC_PERIOD`
         Date.now() - _this.disconnectedAt >= OUT_OF_SYNC_PERIOD) {
-          _this.documentService.throttledCatchupv2();
+          _this.documentService.throttledCatchupv2(CatchupEventReason.RECONNECTED);
         }
         _this.participantsService.startInactiveRemover(_this.sessionId);
         _this.disconnectedAt = undefined;

package/dist/esm/version-wrapper.js

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

package/dist/types/channel.d.ts

@@ -1,5 +1,6 @@
 import { Emitter } from './emitter';
 import type { Config, ChannelEvent, CatchupResponse, Catchupv2Response, ReconcileResponse } from './types';
+import { type CatchupEventReason } from './helpers/const';
 import type { Socket } from 'socket.io-client';
 import type AnalyticsHelper from './analytics/analytics-helper';
 import type { Metadata } from '@atlaskit/editor-common/collab';
@@ -40,7 +41,7 @@ export declare class Channel extends Emitter<ChannelEvent> {
     private onConnect;
     private onReceiveData;
     fetchCatchup: (fromVersion: number, clientId: number | string | undefined) => Promise<CatchupResponse>;
-    fetchCatchupv2: (fromVersion: number, clientId: number | string | undefined, catchUpOutofSync: boolean | undefined) => Promise<Catchupv2Response>;
+    fetchCatchupv2: (fromVersion: number, clientId: number | string | undefined, catchUpOutofSync: boolean | undefined, reason?: CatchupEventReason) => Promise<Catchupv2Response>;
     fetchReconcile: (currentStateDoc: string, reason: string) => Promise<ReconcileResponse>;
     /**
      * Send message to the back-end service over the channel. Timestamp will be added server side.

package/dist/types/document/document-service.d.ts

@@ -1,6 +1,7 @@
 import type { ResolvedEditorState, SyncUpErrorFunction } from '@atlaskit/editor-common/collab';
 import type { Step as ProseMirrorStep } from '@atlaskit/editor-prosemirror/transform';
 import type AnalyticsHelper from '../analytics/analytics-helper';
+import { CatchupEventReason } from '../helpers/const';
 import type { MetadataService } from '../metadata/metadata-service';
 import type { CatchupResponse, Catchupv2Response, ChannelEvent, ReconcileResponse, StepsPayload } from '../types';
 import type { CollabEvents, CollabInitPayload } from '@atlaskit/editor-common/collab';
@@ -58,12 +59,14 @@ export declare class DocumentService {
     private catchup;
     /**
      * To prevent calling catchup to often, use lodash throttle to reduce the frequency
+     * @param reason - optional reason to attach.
      */
-    throttledCatchupv2: import("lodash").DebouncedFunc<() => Promise<void>>;
+    throttledCatchupv2: import("lodash").DebouncedFunc<(reason?: CatchupEventReason) => Promise<void>>;
     /**
      * Called when:
      *   * session established(offline -> online)
      *   * try to accept steps but version is behind.
+     * @param reason - optional reason to attach.
      */
     private catchupv2;
     getCurrentPmVersion: () => number;
@@ -77,7 +80,7 @@ export declare class DocumentService {
      * Called when we receive steps from the service
      */
     onStepsAdded: (data: StepsPayload) => void;
-    onRestore: ({ doc, version, metadata }: CollabInitPayload) => Promise<void>;
+    onRestore: ({ doc, version, metadata, targetClientId }: CollabInitPayload) => Promise<void>;
     getFinalAcknowledgedState: () => Promise<ResolvedEditorState>;
     updateDocument: ({ doc, version, metadata, reserveCursor }: CollabInitPayload) => void;
     private updateDocumentAnalytics;

package/dist/types/helpers/const.d.ts

@@ -254,4 +254,11 @@ type UpdateDocumentAnalyticsEvent = {
 export type ActionAnalyticsEvent = AddStepsSuccessAnalyticsEvent | AddStepsFailureAnalyticsEvent | ReInitDocFailAnalyticsEvent | ReInitDocSuccessAnalyticsEvent | ConnectionSuccessAnalyticsEvent | ConnectionFailureAnalyticsEvent | CatchUpSuccessAnalyticsEvent | CatchUpFailureAnalyticsEvent | DocumentInitSuccessAnalyticsEvent | UpdateParticipantsSuccessAnalyticsEvent | CommitUnconfirmedStepsSuccessAnalyticsEvent | CommitUnconfirmedStepsFailureAnalyticsEvent | PublishPageSuccessAnalyticsEvent | PublishPageFailureAnalyticsEvent | GetCurrentStateSuccessAnalyticsEvent | GetCurrentStateFailureAnalyticsEvent | InvalidateTokenAnalyticsEvent | SendStepsRetryAnalyticsEvent | CatchupAfterMaxSendStepsRetryAnalyticsEvent | CatchUpDroppedStepsEvent | WebsocketMessageVolumeMetricEvent | ProviderInitializedAnalyticsEvent | ProviderSetupAnalyticsEvent | ProviderHasUnconfirmedStepsAnalyticsEvent | UpdateDocumentAnalyticsEvent;
 export declare const ACK_MAX_TRY = 60;
 export declare const CONFLUENCE = "confluence";
+/** Enumerable for attaching a reason to catchup (v2) call(s) */
+export declare enum CatchupEventReason {
+    STEPS_ADDED = "onStepsAdded",
+    STEPS_REJECTED = "onStepsRejected",
+    PROCESS_STEPS = "processSteps",
+    RECONNECTED = "reconnected"
+}
 export {};

package/dist/types/types.d.ts

@@ -6,6 +6,7 @@ import type { JSONDocNode } from '@atlaskit/editor-json-transformer';
 import type { GetUserType } from './participants/participants-helper';
 import type AnalyticsHelper from './analytics/analytics-helper';
 import type { CollabInitPayload, StepJson, CollabSendableSelection, Metadata, UserPermitType, Activity } from '@atlaskit/editor-common/collab';
+import { type CatchupEventReason } from './helpers/const';
 export type { CollabParticipant, CollabEventInitData, CollabEventRemoteData, CollabEventConnectionData, CollabEventConnectingData, CollabEventPresenceData, ResolvedEditorState, CollabConnectedPayload, CollabConnectingPayload, CollabDisconnectedPayload, CollabInitPayload, CollabDataPayload, CollabTelepointerPayload, CollabPresencePayload, CollabMetadataPayload, CollabLocalStepsPayload, CollabCommitStatusEventPayload, CollabPermissionEventPayload, UserPermitType, CollabEvents, Metadata, StepJson, CollabEventTelepointerData, CollabSendableSelection, CollabEditProvider, NewCollabSyncUpErrorAttributes, SyncUpErrorFunction, CollabEventLocalStepData, } from '@atlaskit/editor-common/collab';
 export interface CollabEventDisconnectedData {
     sid: string;
@@ -216,12 +217,13 @@ export interface CatchupOptions {
 }
 export interface Catchupv2Options {
     getCurrentPmVersion: () => number;
-    fetchCatchupv2: (fromVersion: number, clientId: number | string | undefined, catchUpOutofSync: boolean) => Promise<Catchupv2Response>;
+    fetchCatchupv2: (fromVersion: number, clientId: number | string | undefined, catchUpOutofSync: boolean, reason?: CatchupEventReason) => Promise<Catchupv2Response>;
     updateMetadata: (metadata: Metadata | undefined) => void;
     analyticsHelper: AnalyticsHelper | undefined;
     clientId: number | string | undefined;
     onStepsAdded: (data: StepsPayload) => void;
     catchUpOutofSync: boolean;
+    reason?: CatchupEventReason;
 }
 export type ProductInformation = {
     product: string;

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

@@ -1,5 +1,6 @@
 import { Emitter } from './emitter';
 import type { Config, ChannelEvent, CatchupResponse, Catchupv2Response, ReconcileResponse } from './types';
+import { type CatchupEventReason } from './helpers/const';
 import type { Socket } from 'socket.io-client';
 import type AnalyticsHelper from './analytics/analytics-helper';
 import type { Metadata } from '@atlaskit/editor-common/collab';
@@ -40,7 +41,7 @@ export declare class Channel extends Emitter<ChannelEvent> {
     private onConnect;
     private onReceiveData;
     fetchCatchup: (fromVersion: number, clientId: number | string | undefined) => Promise<CatchupResponse>;
-    fetchCatchupv2: (fromVersion: number, clientId: number | string | undefined, catchUpOutofSync: boolean | undefined) => Promise<Catchupv2Response>;
+    fetchCatchupv2: (fromVersion: number, clientId: number | string | undefined, catchUpOutofSync: boolean | undefined, reason?: CatchupEventReason) => Promise<Catchupv2Response>;
     fetchReconcile: (currentStateDoc: string, reason: string) => Promise<ReconcileResponse>;
     /**
      * Send message to the back-end service over the channel. Timestamp will be added server side.

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

@@ -1,6 +1,7 @@
 import type { ResolvedEditorState, SyncUpErrorFunction } from '@atlaskit/editor-common/collab';
 import type { Step as ProseMirrorStep } from '@atlaskit/editor-prosemirror/transform';
 import type AnalyticsHelper from '../analytics/analytics-helper';
+import { CatchupEventReason } from '../helpers/const';
 import type { MetadataService } from '../metadata/metadata-service';
 import type { CatchupResponse, Catchupv2Response, ChannelEvent, ReconcileResponse, StepsPayload } from '../types';
 import type { CollabEvents, CollabInitPayload } from '@atlaskit/editor-common/collab';
@@ -58,12 +59,14 @@ export declare class DocumentService {
     private catchup;
     /**
      * To prevent calling catchup to often, use lodash throttle to reduce the frequency
+     * @param reason - optional reason to attach.
      */
-    throttledCatchupv2: import("lodash").DebouncedFunc<() => Promise<void>>;
+    throttledCatchupv2: import("lodash").DebouncedFunc<(reason?: CatchupEventReason) => Promise<void>>;
     /**
      * Called when:
      *   * session established(offline -> online)
      *   * try to accept steps but version is behind.
+     * @param reason - optional reason to attach.
      */
     private catchupv2;
     getCurrentPmVersion: () => number;
@@ -77,7 +80,7 @@ export declare class DocumentService {
      * Called when we receive steps from the service
      */
     onStepsAdded: (data: StepsPayload) => void;
-    onRestore: ({ doc, version, metadata }: CollabInitPayload) => Promise<void>;
+    onRestore: ({ doc, version, metadata, targetClientId }: CollabInitPayload) => Promise<void>;
     getFinalAcknowledgedState: () => Promise<ResolvedEditorState>;
     updateDocument: ({ doc, version, metadata, reserveCursor }: CollabInitPayload) => void;
     private updateDocumentAnalytics;

package/dist/types-ts4.5/helpers/const.d.ts

@@ -254,4 +254,11 @@ type UpdateDocumentAnalyticsEvent = {
 export type ActionAnalyticsEvent = AddStepsSuccessAnalyticsEvent | AddStepsFailureAnalyticsEvent | ReInitDocFailAnalyticsEvent | ReInitDocSuccessAnalyticsEvent | ConnectionSuccessAnalyticsEvent | ConnectionFailureAnalyticsEvent | CatchUpSuccessAnalyticsEvent | CatchUpFailureAnalyticsEvent | DocumentInitSuccessAnalyticsEvent | UpdateParticipantsSuccessAnalyticsEvent | CommitUnconfirmedStepsSuccessAnalyticsEvent | CommitUnconfirmedStepsFailureAnalyticsEvent | PublishPageSuccessAnalyticsEvent | PublishPageFailureAnalyticsEvent | GetCurrentStateSuccessAnalyticsEvent | GetCurrentStateFailureAnalyticsEvent | InvalidateTokenAnalyticsEvent | SendStepsRetryAnalyticsEvent | CatchupAfterMaxSendStepsRetryAnalyticsEvent | CatchUpDroppedStepsEvent | WebsocketMessageVolumeMetricEvent | ProviderInitializedAnalyticsEvent | ProviderSetupAnalyticsEvent | ProviderHasUnconfirmedStepsAnalyticsEvent | UpdateDocumentAnalyticsEvent;
 export declare const ACK_MAX_TRY = 60;
 export declare const CONFLUENCE = "confluence";
+/** Enumerable for attaching a reason to catchup (v2) call(s) */
+export declare enum CatchupEventReason {
+    STEPS_ADDED = "onStepsAdded",
+    STEPS_REJECTED = "onStepsRejected",
+    PROCESS_STEPS = "processSteps",
+    RECONNECTED = "reconnected"
+}
 export {};

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

@@ -6,6 +6,7 @@ import type { JSONDocNode } from '@atlaskit/editor-json-transformer';
 import type { GetUserType } from './participants/participants-helper';
 import type AnalyticsHelper from './analytics/analytics-helper';
 import type { CollabInitPayload, StepJson, CollabSendableSelection, Metadata, UserPermitType, Activity } from '@atlaskit/editor-common/collab';
+import { type CatchupEventReason } from './helpers/const';
 export type { CollabParticipant, CollabEventInitData, CollabEventRemoteData, CollabEventConnectionData, CollabEventConnectingData, CollabEventPresenceData, ResolvedEditorState, CollabConnectedPayload, CollabConnectingPayload, CollabDisconnectedPayload, CollabInitPayload, CollabDataPayload, CollabTelepointerPayload, CollabPresencePayload, CollabMetadataPayload, CollabLocalStepsPayload, CollabCommitStatusEventPayload, CollabPermissionEventPayload, UserPermitType, CollabEvents, Metadata, StepJson, CollabEventTelepointerData, CollabSendableSelection, CollabEditProvider, NewCollabSyncUpErrorAttributes, SyncUpErrorFunction, CollabEventLocalStepData, } from '@atlaskit/editor-common/collab';
 export interface CollabEventDisconnectedData {
     sid: string;
@@ -216,12 +217,13 @@ export interface CatchupOptions {
 }
 export interface Catchupv2Options {
     getCurrentPmVersion: () => number;
-    fetchCatchupv2: (fromVersion: number, clientId: number | string | undefined, catchUpOutofSync: boolean) => Promise<Catchupv2Response>;
+    fetchCatchupv2: (fromVersion: number, clientId: number | string | undefined, catchUpOutofSync: boolean, reason?: CatchupEventReason) => Promise<Catchupv2Response>;
     updateMetadata: (metadata: Metadata | undefined) => void;
     analyticsHelper: AnalyticsHelper | undefined;
     clientId: number | string | undefined;
     onStepsAdded: (data: StepsPayload) => void;
     catchUpOutofSync: boolean;
+    reason?: CatchupEventReason;
 }
 export type ProductInformation = {
     product: string;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/collab-provider",
-	"version": "9.37.7",
+	"version": "9.38.1",
 	"description": "A provider for collaborative editing.",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -34,7 +34,7 @@
 	"dependencies": {
 		"@atlaskit/analytics-gas-types": "^5.1.0",
 		"@atlaskit/analytics-listeners": "^8.11.0",
-		"@atlaskit/editor-common": "^88.9.0",
+		"@atlaskit/editor-common": "^88.11.0",
 		"@atlaskit/editor-json-transformer": "^8.18.0",
 		"@atlaskit/editor-prosemirror": "5.0.1",
 		"@atlaskit/platform-feature-flags": "^0.3.0",