@atlaskit/collab-provider 10.9.3 → 10.9.4

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @atlaskit/collab-provider
 
+## 10.9.4
+
+### Patch Changes
+
+- [#124114](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/124114)
+  [`a0b9383dc1bf3`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/a0b9383dc1bf3) -
+  CEPS-362: add reason to getResolvedEditorState call chain, to allow collab provider/NCS to
+  differentiate between draft sync and publish use cases
+- Updated dependencies
+
 ## 10.9.3
 
 ### Patch Changes

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

@@ -460,63 +460,68 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
         return _ref7.apply(this, arguments);
       };
     }());
-    (0, _defineProperty2.default)(this, "getFinalAcknowledgedState", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4() {
-      var _this$analyticsHelper18, finalAcknowledgedState, currentState, reconcileResponse, measure, _this$analyticsHelper19, _this$analyticsHelper20, _measure2;
-      return _regenerator.default.wrap(function _callee4$(_context4) {
-        while (1) switch (_context4.prev = _context4.next) {
-          case 0:
-            _this.aggressiveCatchup = true;
-            _context4.prev = 1;
-            (0, _performance.startMeasure)(_performance.MEASURE_NAME.PUBLISH_PAGE, _this.analyticsHelper);
-            _context4.prev = 3;
-            _context4.next = 6;
-            return _this.commitUnconfirmedSteps();
-          case 6:
-            _context4.next = 8;
-            return _this.getCurrentState();
-          case 8:
-            finalAcknowledgedState = _context4.sent;
-            _context4.next = 20;
-            break;
-          case 11:
-            _context4.prev = 11;
-            _context4.t0 = _context4["catch"](3);
-            _context4.next = 15;
-            return _this.getCurrentState();
-          case 15:
-            currentState = _context4.sent;
-            _context4.next = 18;
-            return _this.fetchReconcile(JSON.stringify(currentState.content), 'fe-final-ack');
-          case 18:
-            reconcileResponse = _context4.sent;
-            finalAcknowledgedState = {
-              content: JSON.parse(reconcileResponse.document),
-              title: currentState.title,
-              stepVersion: reconcileResponse.version
-            };
-          case 20:
-            measure = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.PUBLISH_PAGE, _this.analyticsHelper);
-            (_this$analyticsHelper18 = _this.analyticsHelper) === null || _this$analyticsHelper18 === void 0 || _this$analyticsHelper18.sendActionEvent(_const.EVENT_ACTION.PUBLISH_PAGE, _const.EVENT_STATUS.SUCCESS, {
-              latency: measure === null || measure === void 0 ? void 0 : measure.duration
-            });
-            _this.aggressiveCatchup = false;
-            return _context4.abrupt("return", finalAcknowledgedState);
-          case 26:
-            _context4.prev = 26;
-            _context4.t1 = _context4["catch"](1);
-            _this.aggressiveCatchup = false;
-            _measure2 = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.PUBLISH_PAGE, _this.analyticsHelper);
-            (_this$analyticsHelper19 = _this.analyticsHelper) === null || _this$analyticsHelper19 === void 0 || _this$analyticsHelper19.sendActionEvent(_const.EVENT_ACTION.PUBLISH_PAGE, _const.EVENT_STATUS.FAILURE, {
-              latency: _measure2 === null || _measure2 === void 0 ? void 0 : _measure2.duration
-            });
-            (_this$analyticsHelper20 = _this.analyticsHelper) === null || _this$analyticsHelper20 === void 0 || _this$analyticsHelper20.sendErrorEvent(_context4.t1, 'Error while returning ADF version of the final draft document');
-            throw _context4.t1;
-          case 33:
-          case "end":
-            return _context4.stop();
-        }
-      }, _callee4, null, [[1, 26], [3, 11]]);
-    })));
+    (0, _defineProperty2.default)(this, "getFinalAcknowledgedState", /*#__PURE__*/function () {
+      var _ref8 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4(reason) {
+        var _this$analyticsHelper18, finalAcknowledgedState, currentState, reconcileResponse, measure, _this$analyticsHelper19, _this$analyticsHelper20, _measure2;
+        return _regenerator.default.wrap(function _callee4$(_context4) {
+          while (1) switch (_context4.prev = _context4.next) {
+            case 0:
+              _this.aggressiveCatchup = true;
+              _context4.prev = 1;
+              (0, _performance.startMeasure)(_performance.MEASURE_NAME.PUBLISH_PAGE, _this.analyticsHelper);
+              _context4.prev = 3;
+              _context4.next = 6;
+              return _this.commitUnconfirmedSteps(reason);
+            case 6:
+              _context4.next = 8;
+              return _this.getCurrentState();
+            case 8:
+              finalAcknowledgedState = _context4.sent;
+              _context4.next = 20;
+              break;
+            case 11:
+              _context4.prev = 11;
+              _context4.t0 = _context4["catch"](3);
+              _context4.next = 15;
+              return _this.getCurrentState();
+            case 15:
+              currentState = _context4.sent;
+              _context4.next = 18;
+              return _this.fetchReconcile(JSON.stringify(currentState.content), 'fe-final-ack');
+            case 18:
+              reconcileResponse = _context4.sent;
+              finalAcknowledgedState = {
+                content: JSON.parse(reconcileResponse.document),
+                title: currentState.title,
+                stepVersion: reconcileResponse.version
+              };
+            case 20:
+              measure = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.PUBLISH_PAGE, _this.analyticsHelper);
+              (_this$analyticsHelper18 = _this.analyticsHelper) === null || _this$analyticsHelper18 === void 0 || _this$analyticsHelper18.sendActionEvent(_const.EVENT_ACTION.PUBLISH_PAGE, _const.EVENT_STATUS.SUCCESS, {
+                latency: measure === null || measure === void 0 ? void 0 : measure.duration
+              });
+              _this.aggressiveCatchup = false;
+              return _context4.abrupt("return", finalAcknowledgedState);
+            case 26:
+              _context4.prev = 26;
+              _context4.t1 = _context4["catch"](1);
+              _this.aggressiveCatchup = false;
+              _measure2 = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.PUBLISH_PAGE, _this.analyticsHelper);
+              (_this$analyticsHelper19 = _this.analyticsHelper) === null || _this$analyticsHelper19 === void 0 || _this$analyticsHelper19.sendActionEvent(_const.EVENT_ACTION.PUBLISH_PAGE, _const.EVENT_STATUS.FAILURE, {
+                latency: _measure2 === null || _measure2 === void 0 ? void 0 : _measure2.duration
+              });
+              (_this$analyticsHelper20 = _this.analyticsHelper) === null || _this$analyticsHelper20 === void 0 || _this$analyticsHelper20.sendErrorEvent(_context4.t1, 'Error while returning ADF version of the final draft document');
+              throw _context4.t1;
+            case 33:
+            case "end":
+              return _context4.stop();
+          }
+        }, _callee4, null, [[1, 26], [3, 11]]);
+      }));
+      return function (_x4) {
+        return _ref8.apply(this, arguments);
+      };
+    }());
     (0, _defineProperty2.default)(this, "updateDocument", function (_ref9) {
       var doc = _ref9.doc,
         version = _ref9.version,
@@ -607,100 +612,105 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
      * Commit the unconfirmed local steps to the back-end service
      * @throws {Error} Couldn't sync the steps after retrying 30 times
      */
-    (0, _defineProperty2.default)(this, "commitUnconfirmedSteps", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee5() {
-      var unconfirmedSteps, _this$getState6, _this$analyticsHelper25, count, unconfirmedTrs, lastTr, isLastTrConfirmed, _this$analyticsHelper24, nextUnconfirmedSteps, nextUnconfirmedTrs, _this$getUnconfirmedS, state, version, unconfirmedStepsInfoUGCRemoved, error, measure, _this$analyticsHelper26, _this$analyticsHelper27, _measure3;
-      return _regenerator.default.wrap(function _callee5$(_context5) {
-        while (1) switch (_context5.prev = _context5.next) {
-          case 0:
-            unconfirmedSteps = _this.getUnconfirmedSteps();
-            _context5.prev = 1;
-            if (!(unconfirmedSteps !== null && unconfirmedSteps !== void 0 && unconfirmedSteps.length)) {
-              _context5.next = 24;
-              break;
-            }
-            (0, _performance.startMeasure)(_performance.MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS, _this.analyticsHelper);
-            count = 0; // We use origins here as steps can be rebased. When steps are rebased a new step is created.
-            // This means that we can not track if it has been removed from the unconfirmed array or not.
-            // Origins points to the original transaction that the step was created in. This is never changed
-            // and gets passed down when a step is rebased.
-            unconfirmedTrs = _this.getUnconfirmedStepsOrigins();
-            lastTr = unconfirmedTrs === null || unconfirmedTrs === void 0 ? void 0 : unconfirmedTrs[unconfirmedTrs.length - 1];
-            isLastTrConfirmed = false;
-            if (!((_this$getState6 = _this.getState) !== null && _this$getState6 !== void 0 && _this$getState6.call(_this))) {
-              (_this$analyticsHelper24 = _this.analyticsHelper) === null || _this$analyticsHelper24 === void 0 || _this$analyticsHelper24.sendErrorEvent(new Error('Editor state is undefined'), 'commitUnconfirmedSteps called without state');
-            }
-          case 9:
-            if (isLastTrConfirmed) {
-              _context5.next = 22;
+    (0, _defineProperty2.default)(this, "commitUnconfirmedSteps", /*#__PURE__*/function () {
+      var _ref10 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee5(reason) {
+        var unconfirmedSteps, _this$getState6, _this$analyticsHelper25, count, unconfirmedTrs, lastTr, isLastTrConfirmed, _this$analyticsHelper24, nextUnconfirmedSteps, nextUnconfirmedTrs, _this$getUnconfirmedS, state, version, unconfirmedStepsInfoUGCRemoved, error, measure, _this$analyticsHelper26, _this$analyticsHelper27, _measure3;
+        return _regenerator.default.wrap(function _callee5$(_context5) {
+          while (1) switch (_context5.prev = _context5.next) {
+            case 0:
+              unconfirmedSteps = _this.getUnconfirmedSteps();
+              _context5.prev = 1;
+              if (!(unconfirmedSteps !== null && unconfirmedSteps !== void 0 && unconfirmedSteps.length)) {
+                _context5.next = 24;
+                break;
+              }
+              (0, _performance.startMeasure)(_performance.MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS, _this.analyticsHelper);
+              count = 0; // We use origins here as steps can be rebased. When steps are rebased a new step is created.
+              // This means that we can not track if it has been removed from the unconfirmed array or not.
+              // Origins points to the original transaction that the step was created in. This is never changed
+              // and gets passed down when a step is rebased.
+              unconfirmedTrs = _this.getUnconfirmedStepsOrigins();
+              lastTr = unconfirmedTrs === null || unconfirmedTrs === void 0 ? void 0 : unconfirmedTrs[unconfirmedTrs.length - 1];
+              isLastTrConfirmed = false;
+              if (!((_this$getState6 = _this.getState) !== null && _this$getState6 !== void 0 && _this$getState6.call(_this))) {
+                (_this$analyticsHelper24 = _this.analyticsHelper) === null || _this$analyticsHelper24 === void 0 || _this$analyticsHelper24.sendErrorEvent(new Error('Editor state is undefined'), 'commitUnconfirmedSteps called without state');
+              }
+            case 9:
+              if (isLastTrConfirmed) {
+                _context5.next = 22;
+                break;
+              }
+              // forcePublish = true, this is because commitUnconfirmedSteps is only called when the Editor publishes a document
+              _this.sendStepsFromCurrentState(undefined, reason);
+              _context5.next = 13;
+              return (0, _utils.sleep)(500);
+            case 13:
+              nextUnconfirmedSteps = _this.getUnconfirmedSteps();
+              if (nextUnconfirmedSteps !== null && nextUnconfirmedSteps !== void 0 && nextUnconfirmedSteps.length) {
+                nextUnconfirmedTrs = _this.getUnconfirmedStepsOrigins();
+                isLastTrConfirmed = !(nextUnconfirmedTrs !== null && nextUnconfirmedTrs !== void 0 && nextUnconfirmedTrs.some(function (tr) {
+                  return tr === lastTr;
+                }));
+              } else {
+                isLastTrConfirmed = true;
+              }
+              if (!(!isLastTrConfirmed && count++ >= _const.ACK_MAX_TRY)) {
+                _context5.next = 20;
+                break;
+              }
+              if (_this.onSyncUpError) {
+                // Ignored via go/ees005
+                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+                state = _this.getState();
+                version = _this.getVersionFromCollabState(state, 'collab-provider: commitUnconfirmedSteps');
+                _this.onSyncUpError({
+                  lengthOfUnconfirmedSteps: nextUnconfirmedSteps === null || nextUnconfirmedSteps === void 0 ? void 0 : nextUnconfirmedSteps.length,
+                  tries: count,
+                  maxRetries: _const.ACK_MAX_TRY,
+                  clientId: _this.clientId,
+                  version: version
+                });
+              }
+              unconfirmedStepsInfoUGCRemoved = (_this$getUnconfirmedS = _this.getUnconfirmedSteps()) === null || _this$getUnconfirmedS === void 0 ? void 0 : _this$getUnconfirmedS.map(function (step) {
+                return (0, _utils.getStepUGCFreeDetails)(step);
+              });
+              error = new _customErrors.CantSyncUpError("Can't sync up with Collab Service: unable to send unconfirmed steps and max retry reached", {
+                unconfirmedStepsInfo: unconfirmedStepsInfoUGCRemoved ? JSON.stringify(unconfirmedStepsInfoUGCRemoved) : 'Unable to generate UGC removed step info'
+              });
+              throw error;
+            case 20:
+              _context5.next = 9;
               break;
-            }
-            // forcePublish = true, this is because commitUnconfirmedSteps is only called when the Editor publishes a document
-            _this.sendStepsFromCurrentState(undefined, true);
-            _context5.next = 13;
-            return (0, _utils.sleep)(500);
-          case 13:
-            nextUnconfirmedSteps = _this.getUnconfirmedSteps();
-            if (nextUnconfirmedSteps !== null && nextUnconfirmedSteps !== void 0 && nextUnconfirmedSteps.length) {
-              nextUnconfirmedTrs = _this.getUnconfirmedStepsOrigins();
-              isLastTrConfirmed = !(nextUnconfirmedTrs !== null && nextUnconfirmedTrs !== void 0 && nextUnconfirmedTrs.some(function (tr) {
-                return tr === lastTr;
-              }));
-            } else {
-              isLastTrConfirmed = true;
-            }
-            if (!(!isLastTrConfirmed && count++ >= _const.ACK_MAX_TRY)) {
-              _context5.next = 20;
+            case 22:
+              measure = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS, _this.analyticsHelper);
+              (_this$analyticsHelper25 = _this.analyticsHelper) === null || _this$analyticsHelper25 === void 0 || _this$analyticsHelper25.sendActionEvent(_const.EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS, _const.EVENT_STATUS.SUCCESS, {
+                latency: measure === null || measure === void 0 ? void 0 : measure.duration,
+                // upon success, emit the total number of unconfirmed steps we synced
+                numUnconfirmedSteps: unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length
+              });
+            case 24:
+              _context5.next = 32;
               break;
-            }
-            if (_this.onSyncUpError) {
-              // Ignored via go/ees005
-              // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-              state = _this.getState();
-              version = _this.getVersionFromCollabState(state, 'collab-provider: commitUnconfirmedSteps');
-              _this.onSyncUpError({
-                lengthOfUnconfirmedSteps: nextUnconfirmedSteps === null || nextUnconfirmedSteps === void 0 ? void 0 : nextUnconfirmedSteps.length,
-                tries: count,
-                maxRetries: _const.ACK_MAX_TRY,
-                clientId: _this.clientId,
-                version: version
+            case 26:
+              _context5.prev = 26;
+              _context5.t0 = _context5["catch"](1);
+              _measure3 = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS, _this.analyticsHelper);
+              (_this$analyticsHelper26 = _this.analyticsHelper) === null || _this$analyticsHelper26 === void 0 || _this$analyticsHelper26.sendActionEvent(_const.EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS, _const.EVENT_STATUS.FAILURE, {
+                latency: _measure3 === null || _measure3 === void 0 ? void 0 : _measure3.duration,
+                numUnconfirmedSteps: unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length
               });
-            }
-            unconfirmedStepsInfoUGCRemoved = (_this$getUnconfirmedS = _this.getUnconfirmedSteps()) === null || _this$getUnconfirmedS === void 0 ? void 0 : _this$getUnconfirmedS.map(function (step) {
-              return (0, _utils.getStepUGCFreeDetails)(step);
-            });
-            error = new _customErrors.CantSyncUpError("Can't sync up with Collab Service: unable to send unconfirmed steps and max retry reached", {
-              unconfirmedStepsInfo: unconfirmedStepsInfoUGCRemoved ? JSON.stringify(unconfirmedStepsInfoUGCRemoved) : 'Unable to generate UGC removed step info'
-            });
-            throw error;
-          case 20:
-            _context5.next = 9;
-            break;
-          case 22:
-            measure = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS, _this.analyticsHelper);
-            (_this$analyticsHelper25 = _this.analyticsHelper) === null || _this$analyticsHelper25 === void 0 || _this$analyticsHelper25.sendActionEvent(_const.EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS, _const.EVENT_STATUS.SUCCESS, {
-              latency: measure === null || measure === void 0 ? void 0 : measure.duration,
-              // upon success, emit the total number of unconfirmed steps we synced
-              numUnconfirmedSteps: unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length
-            });
-          case 24:
-            _context5.next = 32;
-            break;
-          case 26:
-            _context5.prev = 26;
-            _context5.t0 = _context5["catch"](1);
-            _measure3 = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.COMMIT_UNCONFIRMED_STEPS, _this.analyticsHelper);
-            (_this$analyticsHelper26 = _this.analyticsHelper) === null || _this$analyticsHelper26 === void 0 || _this$analyticsHelper26.sendActionEvent(_const.EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS, _const.EVENT_STATUS.FAILURE, {
-              latency: _measure3 === null || _measure3 === void 0 ? void 0 : _measure3.duration,
-              numUnconfirmedSteps: unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length
-            });
-            (_this$analyticsHelper27 = _this.analyticsHelper) === null || _this$analyticsHelper27 === void 0 || _this$analyticsHelper27.sendErrorEvent(_context5.t0, 'Error while committing unconfirmed steps');
-            throw _context5.t0;
-          case 32:
-          case "end":
-            return _context5.stop();
-        }
-      }, _callee5, null, [[1, 26]]);
-    })));
+              (_this$analyticsHelper27 = _this.analyticsHelper) === null || _this$analyticsHelper27 === void 0 || _this$analyticsHelper27.sendErrorEvent(_context5.t0, 'Error while committing unconfirmed steps');
+              throw _context5.t0;
+            case 32:
+            case "end":
+              return _context5.stop();
+          }
+        }, _callee5, null, [[1, 26]]);
+      }));
+      return function (_x5) {
+        return _ref10.apply(this, arguments);
+      };
+    }());
     (0, _defineProperty2.default)(this, "onStepRejectedError", function () {
       var _this$analyticsHelper28;
       _this.stepRejectCounter++;
@@ -883,7 +893,7 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
      */
   }, {
     key: "sendStepsFromCurrentState",
-    value: function sendStepsFromCurrentState(sendAnalyticsEvent, forcePublish) {
+    value: function sendStepsFromCurrentState(sendAnalyticsEvent, reason) {
       var _this$getState8;
       var state = (_this$getState8 = this.getState) === null || _this$getState8 === void 0 ? void 0 : _this$getState8.call(this);
       if (!state) {
@@ -891,7 +901,7 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
         (_this$analyticsHelper33 = this.analyticsHelper) === null || _this$analyticsHelper33 === void 0 || _this$analyticsHelper33.sendErrorEvent(new Error('Editor state is undefined'), 'sendStepsFromCurrentState called without state');
         return;
       }
-      this.send(null, null, state, sendAnalyticsEvent, forcePublish);
+      this.send(null, null, state, sendAnalyticsEvent, reason);
     }
   }, {
     key: "send",
@@ -900,7 +910,8 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
      * Send steps from transaction to other participants
      * It needs the superfluous arguments because we keep the interface of the send API the same as the Synchrony plugin
      */
-    function send(tr, _oldState, newState, sendAnalyticsEvent, forcePublish) {
+    function send(tr, _oldState, newState, sendAnalyticsEvent, reason // only used for publish and draft-sync events - when called through getFinalAcknowledgedState
+    ) {
       var unconfirmedStepsData = (0, _prosemirrorCollab.sendableSteps)(newState);
       var version = this.getVersionFromCollabState(newState, 'collab-provider: send');
 
@@ -983,7 +994,7 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
         __livePage: this.options.__livePage,
         hasRecovered: this.hasRecovered,
         collabMode: this.participantsService.getCollabMode(),
-        forcePublish: forcePublish
+        reason: reason
       });
     }
   }]);

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

@@ -46,7 +46,7 @@ var NullDocumentService = exports.NullDocumentService = /*#__PURE__*/function ()
     }
   }, {
     key: "getFinalAcknowledgedState",
-    value: function getFinalAcknowledgedState() {
+    value: function getFinalAcknowledgedState(reason) {
       return Promise.resolve({});
     }
   }, {

package/dist/cjs/provider/commit-step.js

@@ -30,7 +30,7 @@ var commitStepQueue = exports.commitStepQueue = function commitStepQueue(_ref) {
     __livePage = _ref.__livePage,
     hasRecovered = _ref.hasRecovered,
     collabMode = _ref.collabMode,
-    forcePublish = _ref.forcePublish;
+    reason = _ref.reason;
   if (!readyToCommit) {
     logger('Not ready to commit, skip');
     return;
@@ -92,8 +92,7 @@ var commitStepQueue = exports.commitStepQueue = function commitStepQueue(_ref) {
       collabMode: collabMode,
       steps: stepsWithClientAndUserId,
       version: version,
-      userId: userId,
-      forcePublish: forcePublish
+      userId: userId
     }, function (response) {
       var latency = new Date().getTime() - start;
       if (timer) {

package/dist/cjs/provider/index.js

@@ -277,27 +277,32 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
      * Used when returning the document to Confluence on publish.
      * @throws {GetFinalAcknowledgedStateError} Something went wrong while returning the acknowledged state
      */
-    (0, _defineProperty2.default)(_this, "getFinalAcknowledgedState", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3() {
-      var _this$analyticsHelper5;
-      return _regenerator.default.wrap(function _callee3$(_context3) {
-        while (1) switch (_context3.prev = _context3.next) {
-          case 0:
-            _context3.prev = 0;
-            _context3.next = 3;
-            return _this.documentService.getFinalAcknowledgedState();
-          case 3:
-            return _context3.abrupt("return", _context3.sent);
-          case 6:
-            _context3.prev = 6;
-            _context3.t0 = _context3["catch"](0);
-            (_this$analyticsHelper5 = _this.analyticsHelper) === null || _this$analyticsHelper5 === void 0 || _this$analyticsHelper5.sendErrorEvent(_context3.t0, 'Error while returning ADF version of the final draft document');
-            throw new _customErrors.GetFinalAcknowledgedStateError('Error while returning the final acknowledged state of the draft document', _context3.t0);
-          case 10:
-          case "end":
-            return _context3.stop();
-        }
-      }, _callee3, null, [[0, 6]]);
-    })));
+    (0, _defineProperty2.default)(_this, "getFinalAcknowledgedState", /*#__PURE__*/function () {
+      var _ref7 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3(reason) {
+        var _this$analyticsHelper5;
+        return _regenerator.default.wrap(function _callee3$(_context3) {
+          while (1) switch (_context3.prev = _context3.next) {
+            case 0:
+              _context3.prev = 0;
+              _context3.next = 3;
+              return _this.documentService.getFinalAcknowledgedState(reason);
+            case 3:
+              return _context3.abrupt("return", _context3.sent);
+            case 6:
+              _context3.prev = 6;
+              _context3.t0 = _context3["catch"](0);
+              (_this$analyticsHelper5 = _this.analyticsHelper) === null || _this$analyticsHelper5 === void 0 || _this$analyticsHelper5.sendErrorEvent(_context3.t0, 'Error while returning ADF version of the final draft document');
+              throw new _customErrors.GetFinalAcknowledgedStateError('Error while returning the final acknowledged state of the draft document', _context3.t0);
+            case 10:
+            case "end":
+              return _context3.stop();
+          }
+        }, _callee3, null, [[0, 6]]);
+      }));
+      return function (_x2) {
+        return _ref7.apply(this, arguments);
+      };
+    }());
     (0, _defineProperty2.default)(_this, "getUnconfirmedSteps", function () {
       return _this.documentService.getUnconfirmedSteps();
     });
@@ -354,7 +359,7 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
     }
     _this.sendStepsTimer = setInterval(function () {
       logger('Intervally sendStepsFromCurrentState');
-      _this.documentService.sendStepsFromCurrentState(true);
+      _this.documentService.sendStepsFromCurrentState(true, undefined);
     }, 5000);
     return _this;
   }

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

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

@@ -398,14 +398,14 @@ export class DocumentService {
         });
       }
     });
-    _defineProperty(this, "getFinalAcknowledgedState", async () => {
+    _defineProperty(this, "getFinalAcknowledgedState", async reason => {
       this.aggressiveCatchup = true;
       try {
         var _this$analyticsHelper18;
         startMeasure(MEASURE_NAME.PUBLISH_PAGE, this.analyticsHelper);
         let finalAcknowledgedState;
         try {
-          await this.commitUnconfirmedSteps();
+          await this.commitUnconfirmedSteps(reason);
           finalAcknowledgedState = await this.getCurrentState();
         } catch (error) {
           // if fails to commit unconfirmed steps, send reconcile request to NCS BE and return the doc to CC
@@ -524,7 +524,7 @@ export class DocumentService {
      * Commit the unconfirmed local steps to the back-end service
      * @throws {Error} Couldn't sync the steps after retrying 30 times
      */
-    _defineProperty(this, "commitUnconfirmedSteps", async () => {
+    _defineProperty(this, "commitUnconfirmedSteps", async reason => {
       const unconfirmedSteps = this.getUnconfirmedSteps();
       try {
         if (unconfirmedSteps !== null && unconfirmedSteps !== void 0 && unconfirmedSteps.length) {
@@ -544,7 +544,7 @@ export class DocumentService {
           }
           while (!isLastTrConfirmed) {
             // forcePublish = true, this is because commitUnconfirmedSteps is only called when the Editor publishes a document
-            this.sendStepsFromCurrentState(undefined, true);
+            this.sendStepsFromCurrentState(undefined, reason);
             await sleep(500);
             const nextUnconfirmedSteps = this.getUnconfirmedSteps();
             if (nextUnconfirmedSteps !== null && nextUnconfirmedSteps !== void 0 && nextUnconfirmedSteps.length) {
@@ -758,7 +758,7 @@ export class DocumentService {
    * The getState function will return the current EditorState
    * from the EditorView.
    */
-  sendStepsFromCurrentState(sendAnalyticsEvent, forcePublish) {
+  sendStepsFromCurrentState(sendAnalyticsEvent, reason) {
     var _this$getState8;
     const state = (_this$getState8 = this.getState) === null || _this$getState8 === void 0 ? void 0 : _this$getState8.call(this);
     if (!state) {
@@ -766,13 +766,14 @@ export class DocumentService {
       (_this$analyticsHelper33 = this.analyticsHelper) === null || _this$analyticsHelper33 === void 0 ? void 0 : _this$analyticsHelper33.sendErrorEvent(new Error('Editor state is undefined'), 'sendStepsFromCurrentState called without state');
       return;
     }
-    this.send(null, null, state, sendAnalyticsEvent, forcePublish);
+    this.send(null, null, state, sendAnalyticsEvent, reason);
   }
   /**
    * Send steps from transaction to other participants
    * It needs the superfluous arguments because we keep the interface of the send API the same as the Synchrony plugin
    */
-  send(tr, _oldState, newState, sendAnalyticsEvent, forcePublish) {
+  send(tr, _oldState, newState, sendAnalyticsEvent, reason // only used for publish and draft-sync events - when called through getFinalAcknowledgedState
+  ) {
     const unconfirmedStepsData = sendableSteps(newState);
     const version = this.getVersionFromCollabState(newState, 'collab-provider: send');
 
@@ -855,7 +856,7 @@ export class DocumentService {
       __livePage: this.options.__livePage,
       hasRecovered: this.hasRecovered,
       collabMode: this.participantsService.getCollabMode(),
-      forcePublish
+      reason
     });
   }
 }

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

@@ -17,7 +17,7 @@ export class NullDocumentService {
   getCurrentState() {
     return Promise.resolve({});
   }
-  getFinalAcknowledgedState() {
+  getFinalAcknowledgedState(reason) {
     return Promise.resolve({});
   }
   getIsNamespaceLocked() {

package/dist/es2019/provider/commit-step.js

@@ -20,7 +20,7 @@ export const commitStepQueue = ({
   __livePage,
   hasRecovered,
   collabMode,
-  forcePublish
+  reason
 }) => {
   if (!readyToCommit) {
     logger('Not ready to commit, skip');
@@ -84,8 +84,7 @@ export const commitStepQueue = ({
       collabMode,
       steps: stepsWithClientAndUserId,
       version,
-      userId,
-      forcePublish
+      userId
     }, response => {
       const latency = new Date().getTime() - start;
       if (timer) {

package/dist/es2019/provider/index.js

@@ -228,9 +228,9 @@ export class Provider extends Emitter {
      * Used when returning the document to Confluence on publish.
      * @throws {GetFinalAcknowledgedStateError} Something went wrong while returning the acknowledged state
      */
-    _defineProperty(this, "getFinalAcknowledgedState", async () => {
+    _defineProperty(this, "getFinalAcknowledgedState", async reason => {
       try {
-        return await this.documentService.getFinalAcknowledgedState();
+        return await this.documentService.getFinalAcknowledgedState(reason);
       } catch (error) {
         var _this$analyticsHelper5;
         (_this$analyticsHelper5 = this.analyticsHelper) === null || _this$analyticsHelper5 === void 0 ? void 0 : _this$analyticsHelper5.sendErrorEvent(error, 'Error while returning ADF version of the final draft document');
@@ -291,7 +291,7 @@ export class Provider extends Emitter {
     }
     this.sendStepsTimer = setInterval(() => {
       logger('Intervally sendStepsFromCurrentState');
-      this.documentService.sendStepsFromCurrentState(true);
+      this.documentService.sendStepsFromCurrentState(true, undefined);
     }, 5000);
   }
   // eslint-disable-next-line @repo/internal/deprecations/deprecation-ticket-required -- Ignored via go/ED-25883

package/dist/es2019/version-wrapper.js

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