@atlaskit/collab-provider 9.38.0 → 9.39.0

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @atlaskit/collab-provider
 
+## 9.39.0
+
+### Minor Changes
+
+- [#138046](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/138046)
+  [`0291f7bee806e`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/0291f7bee806e) -
+  HOT-111468: specifically for experiment teammate presence - add a new method
+  `setupPresenceOnly_do_not_use`, and opt out the document service and api by implementing the
+  `NullDocumentService` and `NullApi` objects when passed in by calling the new setup method, make
+  sure to pass in `clientId`
+
+## 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

package/dist/cjs/api/null-api.js

@@ -0,0 +1,38 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.NullApi = void 0;
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+// A mock for the actual Api class designed for the experiment teammate presence (ATLAS-53155)
+var NullApi = exports.NullApi = /*#__PURE__*/function () {
+  function NullApi() {
+    (0, _classCallCheck2.default)(this, NullApi);
+  }
+  (0, _createClass2.default)(NullApi, [{
+    key: "addComment",
+    value: function () {
+      var _addComment = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
+        return _regenerator.default.wrap(function _callee$(_context) {
+          while (1) switch (_context.prev = _context.next) {
+            case 0:
+              return _context.abrupt("return");
+            case 1:
+            case "end":
+              return _context.stop();
+          }
+        }, _callee);
+      }));
+      function addComment() {
+        return _addComment.apply(this, arguments);
+      }
+      return addComment;
+    }()
+  }]);
+  return NullApi;
+}();

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;
@@ -399,7 +407,7 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
           }
         }, _callee4, null, [[8, 20]]);
       }));
-      return function (_x) {
+      return function (_x2) {
         return _ref6.apply(this, arguments);
       };
     }());
@@ -644,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
@@ -663,12 +671,12 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
     this.providerEmitCallback = providerEmitCallback;
     this.broadcast = broadcast;
     this.getUserId = getUserId;
-    this.onErrorHandled = onErrorHandled;
     this.metadataService = metadataService;
     this.isNameSpaceLocked = isNameSpaceLocked;
     this.enableErrorOnFailedDocumentApply = enableErrorOnFailedDocumentApply;
     this.options = options;
     this.stepQueue = new _stepQueueState.StepQueueState();
+    this.onErrorHandled = onErrorHandled;
   }
   (0, _createClass2.default)(DocumentService, [{
     key: "processQueue",
@@ -722,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/document/interface-document-service.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

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

@@ -0,0 +1,64 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.NullDocumentService = void 0;
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+// A Null object for the actual DocumentService class only for the experiment teammate presence  (ATLAS-53155)
+var NullDocumentService = exports.NullDocumentService = /*#__PURE__*/function () {
+  function NullDocumentService() {
+    var _this = this;
+    (0, _classCallCheck2.default)(this, NullDocumentService);
+    (0, _defineProperty2.default)(this, "setup", function () {
+      return _this;
+    });
+    (0, _defineProperty2.default)(this, "onErrorHandled", function () {});
+  }
+  (0, _createClass2.default)(NullDocumentService, [{
+    key: "updateDocument",
+    value: function updateDocument() {}
+  }, {
+    key: "onRestore",
+    value: function onRestore() {}
+  }, {
+    key: "onStepsAdded",
+    value: function onStepsAdded() {}
+  }, {
+    key: "onStepRejectedError",
+    value: function onStepRejectedError() {}
+  }, {
+    key: "send",
+    value: function send() {}
+  }, {
+    key: "sendStepsFromCurrentState",
+    value: function sendStepsFromCurrentState() {}
+  }, {
+    key: "throttledCatchupv2",
+    value: function throttledCatchupv2() {}
+  }, {
+    key: "getCurrentState",
+    value: function getCurrentState() {
+      return Promise.resolve({});
+    }
+  }, {
+    key: "getFinalAcknowledgedState",
+    value: function getFinalAcknowledgedState() {
+      return Promise.resolve({});
+    }
+  }, {
+    key: "getUnconfirmedSteps",
+    value: function getUnconfirmedSteps() {
+      return undefined;
+    }
+  }, {
+    key: "getCurrentPmVersion",
+    value: function getCurrentPmVersion() {
+      return -1;
+    }
+  }]);
+  return NullDocumentService;
+}();

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

@@ -25,6 +25,7 @@ var _customErrors = require("../errors/custom-errors");
 var _ncsErrors = require("../errors/ncs-errors");
 var _metadataService = require("../metadata/metadata-service");
 var _documentService = require("../document/document-service");
+var _nullDocumentService = require("../document/null-document-service");
 var _namespaceService = require("../namespace/namespace-service");
 var _participantsService = require("../participants/participants-service");
 var _errorCodeMapper = require("../errors/error-code-mapper");
@@ -33,6 +34,7 @@ var _const = require("../helpers/const");
 var _featureFlags = require("../feature-flags");
 var _api = require("../api/api");
 var _performance = require("../analytics/performance");
+var _nullApi = require("../api/null-api");
 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) { (0, _defineProperty2.default)(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; }
 function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = (0, _getPrototypeOf2.default)(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = (0, _getPrototypeOf2.default)(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return (0, _possibleConstructorReturn2.default)(this, result); }; }
@@ -135,7 +137,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;
@@ -282,12 +284,19 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
     _this.participantsService = new _participantsService.ParticipantsService(_this.analyticsHelper, undefined, _this.emitCallback, _this.config.getUser, _this.channel.broadcast, _this.channel.sendPresenceJoined, _this.getPresenceData, _this.setUserId);
     _this.metadataService = new _metadataService.MetadataService(_this.emitCallback, _this.channel.sendMetadata);
     _this.namespaceService = new _namespaceService.NamespaceService();
-    _this.documentService = new _documentService.DocumentService(_this.participantsService, _this.analyticsHelper, _this.channel.fetchCatchup, _this.channel.fetchCatchupv2, _this.channel.fetchReconcile, _this.emitCallback, _this.channel.broadcast, function () {
-      return _this.userId;
-    }, _this.onErrorHandled, _this.metadataService, _this.namespaceService.getIsNamespaceLocked.bind(_this.namespaceService), _this.config.enableErrorOnFailedDocumentApply, {
-      __livePage: _this.config.__livePage || false
-    });
-    _this.api = new _api.Api(config, _this.documentService, _this.channel);
+    if (config.isPresenceOnly_do_not_use) {
+      // this check is specifically for the experiment teammate presence
+      // This presence feature is only for the view pages which do not need the document service or api
+      _this.documentService = new _nullDocumentService.NullDocumentService();
+      _this.api = new _nullApi.NullApi();
+    } else {
+      _this.documentService = new _documentService.DocumentService(_this.participantsService, _this.analyticsHelper, _this.channel.fetchCatchup, _this.channel.fetchCatchupv2, _this.channel.fetchReconcile, _this.emitCallback, _this.channel.broadcast, function () {
+        return _this.userId;
+      }, _this.onErrorHandled, _this.metadataService, _this.namespaceService.getIsNamespaceLocked.bind(_this.namespaceService), _this.config.enableErrorOnFailedDocumentApply, {
+        __livePage: _this.config.__livePage || false
+      });
+      _this.api = new _api.Api(config, _this.documentService, _this.channel);
+    }
     _this.sendStepsTimer = setInterval(function () {
       logger('Intervally sendStepsFromCurrentState');
       _this.documentService.sendStepsFromCurrentState(true);
@@ -369,13 +378,33 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
       }
       return this;
     }
+
+    // Only used for the experiment teammate presence (ATLAS-53155) - opts out of the document service and api service
+  }, {
+    key: "setupPresenceOnly_do_not_use",
+    value: function setupPresenceOnly_do_not_use(clientId) {
+      this.clientId = clientId;
+      this.checkForCookies();
+      try {
+        if (!this.isChannelInitialized) {
+          this.initializeChannel();
+          this.isChannelInitialized = true;
+        }
+      } catch (initError) {
+        var _this$analyticsHelper8;
+        (_this$analyticsHelper8 = this.analyticsHelper) === null || _this$analyticsHelper8 === void 0 || _this$analyticsHelper8.sendErrorEvent(initError, 'Error while initialising the provider');
+        // Throw error so consumers are aware the initialisation failed when initialising themselves
+        throw new _customErrors.ProviderInitialisationError('Provider initialisation error', initError);
+      }
+      return this;
+    }
   }, {
     key: "checkForCookies",
     value: function checkForCookies() {
       if (!global.navigator.cookieEnabled) {
-        var _this$analyticsHelper8;
+        var _this$analyticsHelper9;
         var initError = new _customErrors.ProviderInitialisationError('Cookies are not enabled. Please enable cookies to use collaborative editing.');
-        (_this$analyticsHelper8 = this.analyticsHelper) === null || _this$analyticsHelper8 === void 0 || _this$analyticsHelper8.sendErrorEvent(initError, 'Error while initialising the provider - cookies disabled');
+        (_this$analyticsHelper9 = this.analyticsHelper) === null || _this$analyticsHelper9 === void 0 || _this$analyticsHelper9.sendErrorEvent(initError, 'Error while initialising the provider - cookies disabled');
         throw new _customErrors.ProviderInitialisationError('Provider initialisation error - cookies disabled', initError);
       }
     }
@@ -392,14 +421,14 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
     value: function send(_tr, _oldState, newState) {
       try {
         if (this.isViewOnly()) {
-          var _this$analyticsHelper9;
+          var _this$analyticsHelper10;
           var error = {
             message: 'Attempted to send steps in view only mode',
             data: {
               code: _internalErrors.INTERNAL_ERROR_CODE.VIEW_ONLY_STEPS_ERROR
             }
           };
-          (_this$analyticsHelper9 = this.analyticsHelper) === null || _this$analyticsHelper9 === void 0 || _this$analyticsHelper9.sendErrorEvent(error, error.message);
+          (_this$analyticsHelper10 = this.analyticsHelper) === null || _this$analyticsHelper10 === void 0 || _this$analyticsHelper10.sendErrorEvent(error, error.message);
           return;
         }
         // Don't send steps while the document is locked (eg. when restoring the document)
@@ -409,8 +438,8 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
         }
         this.documentService.send(_tr, _oldState, newState);
       } catch (error) {
-        var _this$analyticsHelper10;
-        (_this$analyticsHelper10 = this.analyticsHelper) === null || _this$analyticsHelper10 === void 0 || _this$analyticsHelper10.sendErrorEvent(error, 'Error while sending steps for a transaction');
+        var _this$analyticsHelper11;
+        (_this$analyticsHelper11 = this.analyticsHelper) === null || _this$analyticsHelper11 === void 0 || _this$analyticsHelper11.sendErrorEvent(error, 'Error while sending steps for a transaction');
         throw new _customErrors.SendTransactionError('Error while sending steps for a transaction', error);
       }
     }
@@ -450,9 +479,9 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
           }), activityCallback());
         }
       } catch (error) {
-        var _this$analyticsHelper11;
+        var _this$analyticsHelper12;
         // We don't want to throw errors for Presence features as they tend to self-restore
-        (_this$analyticsHelper11 = this.analyticsHelper) === null || _this$analyticsHelper11 === void 0 || _this$analyticsHelper11.sendErrorEvent(error, 'Error while sending message - telepointer');
+        (_this$analyticsHelper12 = this.analyticsHelper) === null || _this$analyticsHelper12 === void 0 || _this$analyticsHelper12.sendErrorEvent(error, 'Error while sending message - telepointer');
       }
     }
   }, {
@@ -495,8 +524,8 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
           this.sendStepsTimer = undefined;
         }
       } catch (error) {
-        var _this$analyticsHelper12;
-        (_this$analyticsHelper12 = this.analyticsHelper) === null || _this$analyticsHelper12 === void 0 || _this$analyticsHelper12.sendErrorEvent(error, 'Error while shutting down the collab provider');
+        var _this$analyticsHelper13;
+        (_this$analyticsHelper13 = this.analyticsHelper) === null || _this$analyticsHelper13 === void 0 || _this$analyticsHelper13.sendErrorEvent(error, 'Error while shutting down the collab provider');
         throw new _customErrors.DestroyError('Error while shutting down the collab provider', error);
       }
       this.clearTimers();
@@ -519,8 +548,8 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
         }
         this.metadataService.setTitle(title, broadcast);
       } catch (error) {
-        var _this$analyticsHelper13;
-        (_this$analyticsHelper13 = this.analyticsHelper) === null || _this$analyticsHelper13 === void 0 || _this$analyticsHelper13.sendErrorEvent(error, 'Error while setting title');
+        var _this$analyticsHelper14;
+        (_this$analyticsHelper14 = this.analyticsHelper) === null || _this$analyticsHelper14 === void 0 || _this$analyticsHelper14.sendErrorEvent(error, 'Error while setting title');
         throw new _customErrors.SetTitleError('Error while setting title', error);
       }
     }
@@ -538,8 +567,8 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
       try {
         this.metadataService.setEditorWidth(editorWidth, broadcast);
       } catch (error) {
-        var _this$analyticsHelper14;
-        (_this$analyticsHelper14 = this.analyticsHelper) === null || _this$analyticsHelper14 === void 0 || _this$analyticsHelper14.sendErrorEvent(error, 'Error while setting editor width');
+        var _this$analyticsHelper15;
+        (_this$analyticsHelper15 = this.analyticsHelper) === null || _this$analyticsHelper15 === void 0 || _this$analyticsHelper15.sendErrorEvent(error, 'Error while setting editor width');
         throw new _customErrors.SetEditorWidthError('Error while setting editor width', error);
       }
     }
@@ -558,8 +587,8 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
         }
         this.metadataService.setMetadata(metadata);
       } catch (error) {
-        var _this$analyticsHelper15;
-        (_this$analyticsHelper15 = this.analyticsHelper) === null || _this$analyticsHelper15 === void 0 || _this$analyticsHelper15.sendErrorEvent(error, 'Error while setting metadata');
+        var _this$analyticsHelper16;
+        (_this$analyticsHelper16 = this.analyticsHelper) === null || _this$analyticsHelper16 === void 0 || _this$analyticsHelper16.sendErrorEvent(error, 'Error while setting metadata');
         throw new _customErrors.SetMetadataError('Error while setting metadata', error);
       }
     }

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

package/dist/es2019/api/null-api.js

@@ -0,0 +1,6 @@
+// A mock for the actual Api class designed for the experiment teammate presence (ATLAS-53155)
+export class NullApi {
+  async addComment() {
+    return;
+  }
+}

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');