@atlaskit/collab-provider 10.9.2 → 10.9.4

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # @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
+
+- [#122605](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/122605)
+  [`1bf1493f744ce`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/1bf1493f744ce) -
+  [ux] Add conflict metadata on reconnection
+- Updated dependencies
+
 ## 10.9.2
 
 ### Patch Changes

package/dist/cjs/channel.js

@@ -203,7 +203,7 @@ var Channel = exports.Channel = /*#__PURE__*/function (_Emitter) {
           var measure = (0, _performance.stopMeasure)(_performance.MEASURE_NAME.DOCUMENT_INIT, _this.analyticsHelper);
           (_this$initExperience = _this.initExperience) === null || _this$initExperience === void 0 || _this$initExperience.success();
           (_this$analyticsHelper6 = _this.analyticsHelper) === null || _this$analyticsHelper6 === void 0 || _this$analyticsHelper6.sendActionEvent(_const.EVENT_ACTION.DOCUMENT_INIT,
-          // TODO: detect when document init fails and fire corresponding event for it
+          // TODO: ED-26957 - detect when document init fails and fire corresponding event for it
           _const.EVENT_STATUS.SUCCESS, {
             latency: measure === null || measure === void 0 ? void 0 : measure.duration,
             resetReason: data.resetReason,

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

@@ -12,6 +12,7 @@ var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/creat
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _throttle = _interopRequireDefault(require("lodash/throttle"));
 var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
+var _transform = require("@atlaskit/editor-prosemirror/transform");
 var _prosemirrorCollab = require("@atlaskit/prosemirror-collab");
 var _state = require("@atlaskit/editor-prosemirror/state");
 var _editorJsonTransformer = require("@atlaskit/editor-json-transformer");
@@ -24,6 +25,7 @@ var _commitStep = require("../provider/commit-step");
 var _customErrors = require("../errors/custom-errors");
 var _catchupv = require("./catchupv2");
 var _stepQueueState = require("./step-queue-state");
+var _getConflictChanges = require("./getConflictChanges");
 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; }
 var CATCHUP_THROTTLE = 1 * 1000; // 1 second
@@ -72,7 +74,7 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
       return _this.catchupv2(reason, reconnectionMetadata);
     }, CATCHUP_THROTTLE, {
       leading: false,
-      // TODO: why shouldn't this be leading?
+      // TODO: ED-26957 - why shouldn't this be leading?
       trailing: true
     }));
     /**
@@ -458,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,
@@ -605,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++;
@@ -772,10 +784,21 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
       var state = (_this$getState7 = this.getState) === null || _this$getState7 === void 0 ? void 0 : _this$getState7.call(this);
       var unconfirmedSteps = state ? (_getCollabState = (0, _prosemirrorCollab.getCollabState)(state)) === null || _getCollabState === void 0 ? void 0 : _getCollabState.unconfirmed : undefined;
       if (steps.length > 0 && state && unconfirmedSteps && unconfirmedSteps.length > 0) {
-        // In the future we can determine the type of conflict
-        this.providerEmitCallback('data:conflict', {
-          offlineDoc: state.doc
+        var schema = state.schema,
+          tr = state.tr;
+        var remoteSteps = steps.map(function (s) {
+          return _transform.Step.fromJSON(schema, s);
         });
+        var conflicts = (0, _getConflictChanges.getConflictChanges)({
+          localSteps: unconfirmedSteps,
+          remoteSteps: remoteSteps,
+          tr: tr
+        });
+        if (conflicts.deleted.length > 0 || conflicts.inserted.length > 0) {
+          this.providerEmitCallback('data:conflict', _objectSpread({
+            offlineDoc: state.doc
+          }, conflicts));
+        }
       }
     }
   }, {
@@ -870,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) {
@@ -878,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",
@@ -887,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');
 
@@ -970,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/getConflictChanges.js

@@ -0,0 +1,177 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getConflictChanges = getConflictChanges;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _prosemirrorChangeset = require("prosemirror-changeset");
+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; }
+var simplifySteps = function simplifySteps(steps) {
+  return steps.reduce(function (acc, step) {
+    var lastStep = acc[acc.length - 1];
+    if (lastStep) {
+      var mergedStep = lastStep.merge(step);
+      if (mergedStep) {
+        acc[acc.length - 1] = mergedStep;
+        return acc;
+      }
+    }
+    return acc.concat(step);
+  }, []);
+};
+function findContentChanges(doc, steps) {
+  var changes = _prosemirrorChangeset.ChangeSet.create(doc);
+  var latestDoc = doc;
+  simplifySteps(steps).forEach(function (step, index) {
+    var stepResult = step.apply(latestDoc);
+    if (stepResult.failed !== null || stepResult.doc === null) {
+      return;
+    }
+    latestDoc = stepResult.doc;
+    changes = changes.addSteps(latestDoc, [step.getMap()], {
+      step: index
+    });
+  });
+  return changes;
+}
+
+/**
+ * Iterate through the changesets to find overlapping regions that indicate conflicting
+ * changes
+ */
+var getConflicts = function getConflicts(_ref) {
+  var localChanges = _ref.localChanges,
+    localDoc = _ref.localDoc,
+    remoteChanges = _ref.remoteChanges,
+    remoteDoc = _ref.remoteDoc;
+  var conflictingChanges = [];
+  localChanges.changes.forEach(function (localChange) {
+    remoteChanges.changes.forEach(function (remoteChange) {
+      if (
+      // Local change is inside remote change
+      localChange.fromA >= remoteChange.fromA && localChange.toA <= remoteChange.toA ||
+      // Remote change is inside local change
+      remoteChange.fromA >= localChange.fromA && remoteChange.toA <= localChange.toA ||
+      // Partial overlap with the end
+      localChange.fromA >= remoteChange.fromA && localChange.fromA < remoteChange.toA && localChange.toA > remoteChange.toA ||
+      // Partial overlap with the start
+      localChange.fromA < remoteChange.fromA && localChange.toA > remoteChange.fromA && localChange.toA <= remoteChange.toA) {
+        conflictingChanges.push({
+          from: Math.min(localChange.fromA, remoteChange.fromA),
+          to: Math.max(localChange.toA, remoteChange.toA),
+          local: localDoc.slice(localChange.fromB, localChange.toB, true),
+          remote: remoteDoc.slice(remoteChange.fromB, remoteChange.toB)
+        });
+      }
+    });
+  });
+  return conflictingChanges;
+};
+
+/**
+ * Almost a copy of the rebaseSteps in the collab algorithm (which gets called
+ * synchronously after this).
+ *
+ * This also tracks the intermediate documents so we can generate the changesets
+ * to use for finding any overlapping regions.
+ * See: `packages/editor/prosemirror-collab/src/index.ts`
+ */
+var rebaseSteps = function rebaseSteps(_ref2) {
+  var _tr$mapping$maps;
+  var localSteps = _ref2.localSteps,
+    remoteSteps = _ref2.remoteSteps,
+    tr = _ref2.tr;
+  for (var i = (localSteps === null || localSteps === void 0 ? void 0 : localSteps.length) - 1; i >= 0; i--) {
+    tr.step(localSteps[i].inverted);
+  }
+  var originalDoc = tr.doc;
+  var mapStart = (_tr$mapping$maps = tr.mapping.maps) === null || _tr$mapping$maps === void 0 ? void 0 : _tr$mapping$maps.length;
+  for (var _i = 0; _i < remoteSteps.length; _i++) {
+    tr.step(remoteSteps[_i]);
+  }
+  var remoteDoc = tr.doc;
+  for (var _i2 = 0, mapFrom = localSteps.length; _i2 < localSteps.length; _i2++) {
+    var mapped = localSteps[_i2].step.map(tr.mapping.slice(mapFrom));
+    mapFrom--;
+    if (mapped && !tr.maybeStep(mapped).failed) {
+      // Open ticket for setMirror https://github.com/ProseMirror/prosemirror/issues/869
+      // @ts-expect-error
+      tr.mapping.setMirror(mapFrom, tr.steps.length - 1);
+    }
+  }
+  return {
+    mapStart: mapStart,
+    originalDoc: originalDoc,
+    remoteDoc: remoteDoc
+  };
+};
+
+/**
+ * Gets the conflicts between the local document and the remote document based on steps.
+ * It assumes the steps will be rebased using the `prosemirror-collab` algorithm synchronously after this
+ * Therefore the `tr` property is based on the document before rebasing.
+ *
+ * In the future we could possibly use `prosemirror-recreate-steps` (or similar approach)
+ * and tweak this to work for arbitrary diffs between offline and remote documents.
+ *
+ * @param localSteps Local steps applied between now and the server steps
+ * @param remoteSteps Steps retrieved from the server
+ * @param tr Transaction of the current document (expected to happen with local steps applied, before remote are applied)
+ * @returns All the conflicts (inserted + deleted) which can be applied to the current document
+ */
+function getConflictChanges(_ref3) {
+  var localSteps = _ref3.localSteps,
+    remoteSteps = _ref3.remoteSteps,
+    tr = _ref3.tr;
+  var localDoc = tr.doc;
+  var _rebaseSteps = rebaseSteps({
+      localSteps: localSteps,
+      remoteSteps: remoteSteps,
+      tr: tr
+    }),
+    originalDoc = _rebaseSteps.originalDoc,
+    remoteDoc = _rebaseSteps.remoteDoc,
+    mapStart = _rebaseSteps.mapStart;
+  var localChanges = findContentChanges(originalDoc, localSteps.map(function (s) {
+    return s.step;
+  }));
+  var remoteChanges = findContentChanges(originalDoc, remoteSteps);
+
+  // This is the mapping between the original document and our final one which can be used to
+  // map conflict positions (which are based on the original doc)
+  var mapping = tr.mapping.slice(mapStart);
+
+  // Find the overlapping conflicts - these are based on the positions of the original document so are
+  // common to both local and remote documents.
+  // The above mapping allows us to bring these positions to where they are in the current document
+  var conflictingChanges = getConflicts({
+    localChanges: localChanges,
+    localDoc: localDoc,
+    remoteDoc: remoteDoc,
+    remoteChanges: remoteChanges
+  });
+  var isConflictChange = function isConflictChange(value) {
+    return Boolean(value);
+  };
+  return {
+    inserted: conflictingChanges.filter(function (i) {
+      return i.remote.size !== 0;
+    }).map(function (i) {
+      return _objectSpread(_objectSpread({}, i), {}, {
+        from: mapping.map(i.from, -1),
+        to: mapping.map(i.to)
+      });
+    }).filter(isConflictChange),
+    deleted: conflictingChanges.filter(function (d) {
+      return d.remote.size === 0;
+    }).map(function (d) {
+      return _objectSpread(_objectSpread({}, d), {}, {
+        from: mapping.map(d.from),
+        to: mapping.map(d.to)
+      });
+    }).filter(isConflictChange)
+  };
+}

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({});
     }
   }, {