@atlaskit/collab-provider 10.4.0 → 10.5.0

package/dist/esm/channel.js

@@ -228,8 +228,6 @@ export var Channel = /*#__PURE__*/function (_Emitter) {
         _this.emit('steps:added', data);
       }
     });
-    // Ignored via go/ees005
-    // eslint-disable-next-line @typescript-eslint/max-params
     _defineProperty(_this, "fetchCatchupv2", /*#__PURE__*/function () {
       var _ref2 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2(fromVersion, clientId, catchUpOutofSync, reason) {
         var _yield$utils$requestS, steps, metadata, errorNotFound, errorCatchupv2;

package/dist/esm/document/catchupv2.js

@@ -89,10 +89,7 @@ var logObfuscatedSteps = function logObfuscatedSteps(steps, opt) {
  * @param clientId The ID of the currently connected session (one user can have multiple if theu have multiple tabs open)
  * @returns True if we're out of sync, false if not.
  */
-export var isOutOfSync = function isOutOfSync(fromVersion, currentVersion, steps, clientId
-// Ignored via go/ees005
-// eslint-disable-next-line @typescript-eslint/max-params
-) {
+export var isOutOfSync = function isOutOfSync(fromVersion, currentVersion, steps, clientId) {
   return (
     // If version number hasn't increased, and steps are not from our client, we're out of sync
     Boolean(fromVersion >= currentVersion && steps.some(function (step) {

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

@@ -21,7 +21,7 @@ import { CantSyncUpError, UpdateDocumentError } from '../errors/custom-errors';
 var CATCHUP_THROTTLE = 1 * 1000; // 1 second
 
 var noop = function noop() {};
-var logger = createLogger('documentService', 'black');
+var logger = createLogger('documentService', 'red');
 export var DocumentService = /*#__PURE__*/function () {
   // ClientID is the unique ID for a prosemirror client. Used for step-rebasing.
 
@@ -40,8 +40,6 @@ export var DocumentService = /*#__PURE__*/function () {
    * @param enableErrorOnFailedDocumentApply - Enable failed document update exceptions.
    * @param getConnected - if the channel is currently connected
    */
-  // Ignored via go/ees005
-  // eslint-disable-next-line @typescript-eslint/max-params
   function DocumentService(participantsService, analyticsHelper, fetchCatchupv2, fetchReconcile,
   // Ignored via go/ees005
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -57,6 +55,7 @@ export var DocumentService = /*#__PURE__*/function () {
     _defineProperty(this, "stepRejectCounter", 0);
     _defineProperty(this, "aggressiveCatchup", false);
     _defineProperty(this, "catchUpOutofSync", false);
+    _defineProperty(this, "hasRecovered", false);
     /**
      * To prevent calling catchup to often, use lodash throttle to reduce the frequency
      * @param reason - optional reason to attach.
@@ -308,21 +307,24 @@ export var DocumentService = /*#__PURE__*/function () {
           while (1) switch (_context3.prev = _context3.next) {
             case 0:
               doc = _ref6.doc, version = _ref6.version, metadata = _ref6.metadata, targetClientId = _ref6.targetClientId;
+              if (!targetClientId) {
+                _this.hasRecovered = true;
+              }
               if (!(targetClientId && _this.clientId !== targetClientId)) {
-                _context3.next = 3;
+                _context3.next = 4;
                 break;
               }
               return _context3.abrupt("return");
-            case 3:
+            case 4:
               // We preserve these as they will be lost apon this.updateDocument. This is because we are using document recovery.
               // We can then reconcile the document with the preserved state.
               unconfirmedSteps = _this.getUnconfirmedSteps();
-              _context3.next = 6;
+              _context3.next = 7;
               return _this.getCurrentState();
-            case 6:
+            case 7:
               currentState = _context3.sent;
               useReconcile = Boolean((unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length) && currentState && !targetClientId);
-              _context3.prev = 8;
+              _context3.prev = 9;
               // Reset the editor,
               //  - Replace the document, keep in sync with the server
               //  - Replace the version number, so editor is in sync with NCS server and can commit new changes.
@@ -337,10 +339,10 @@ export var DocumentService = /*#__PURE__*/function () {
               });
               _this.metadataService.updateMetadata(metadata);
               if (!fg('restore_localstep_fallback_reconcile')) {
-                _context3.next = 25;
+                _context3.next = 26;
                 break;
               }
-              _context3.prev = 12;
+              _context3.prev = 13;
               (_this$analyticsHelper13 = _this.analyticsHelper) === null || _this$analyticsHelper13 === void 0 || _this$analyticsHelper13.sendActionEvent(EVENT_ACTION.REINITIALISE_DOCUMENT, EVENT_STATUS.INFO, {
                 numUnconfirmedSteps: unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length,
                 hasTitle: !!(metadata !== null && metadata !== void 0 && metadata.title),
@@ -351,35 +353,35 @@ export var DocumentService = /*#__PURE__*/function () {
               if (unconfirmedSteps !== null && unconfirmedSteps !== void 0 && unconfirmedSteps.length) {
                 _this.applyLocalSteps(unconfirmedSteps);
               }
-              _context3.next = 23;
+              _context3.next = 24;
               break;
-            case 17:
-              _context3.prev = 17;
-              _context3.t0 = _context3["catch"](12);
+            case 18:
+              _context3.prev = 18;
+              _context3.t0 = _context3["catch"](13);
               (_this$analyticsHelper14 = _this.analyticsHelper) === null || _this$analyticsHelper14 === void 0 || _this$analyticsHelper14.sendErrorEvent(_context3.t0, "Error while onRestore with applyLocalSteps. Will fallback to fetchReconcile");
               useReconcile = true;
-              _context3.next = 23;
+              _context3.next = 24;
               return _this.fetchReconcile(JSON.stringify(currentState.content), 'fe-restore');
-            case 23:
-              _context3.next = 31;
+            case 24:
+              _context3.next = 32;
               break;
-            case 25:
+            case 26:
               if (!(useReconcile && currentState)) {
-                _context3.next = 30;
+                _context3.next = 31;
                 break;
               }
-              _context3.next = 28;
+              _context3.next = 29;
               return _this.fetchReconcile(JSON.stringify(currentState.content), 'fe-restore');
-            case 28:
-              _context3.next = 31;
+            case 29:
+              _context3.next = 32;
               break;
-            case 30:
+            case 31:
               if (unconfirmedSteps !== null && unconfirmedSteps !== void 0 && unconfirmedSteps.length) {
                 // we don't want to use reconcile for restore triggered by catchup client out of sync (when targetClientId is provided)
                 // as this results in all changes made while the client was out of sync being lost
                 _this.applyLocalSteps(unconfirmedSteps);
               }
-            case 31:
+            case 32:
               (_this$analyticsHelper15 = _this.analyticsHelper) === null || _this$analyticsHelper15 === void 0 || _this$analyticsHelper15.sendActionEvent(EVENT_ACTION.REINITIALISE_DOCUMENT, EVENT_STATUS.SUCCESS, {
                 numUnconfirmedSteps: unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length,
                 hasTitle: !!(metadata !== null && metadata !== void 0 && metadata.title),
@@ -388,11 +390,11 @@ export var DocumentService = /*#__PURE__*/function () {
                 targetClientId: targetClientId,
                 triggeredByCatchup: targetClientId ? true : false
               });
-              _context3.next = 39;
+              _context3.next = 40;
               break;
-            case 34:
-              _context3.prev = 34;
-              _context3.t1 = _context3["catch"](8);
+            case 35:
+              _context3.prev = 35;
+              _context3.t1 = _context3["catch"](9);
               (_this$analyticsHelper16 = _this.analyticsHelper) === null || _this$analyticsHelper16 === void 0 || _this$analyticsHelper16.sendActionEvent(EVENT_ACTION.REINITIALISE_DOCUMENT, EVENT_STATUS.FAILURE, {
                 numUnconfirmedSteps: unconfirmedSteps === null || unconfirmedSteps === void 0 ? void 0 : unconfirmedSteps.length,
                 useReconcile: useReconcile,
@@ -409,11 +411,11 @@ export var DocumentService = /*#__PURE__*/function () {
                   code: INTERNAL_ERROR_CODE.DOCUMENT_RESTORE_ERROR
                 }
               });
-            case 39:
+            case 40:
             case "end":
               return _context3.stop();
           }
-        }, _callee3, null, [[8, 34], [12, 17]]);
+        }, _callee3, null, [[9, 35], [13, 18]]);
       }));
       return function (_x3) {
         return _ref7.apply(this, arguments);
@@ -824,8 +826,6 @@ export var 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
      */
-    // Ignored via go/ees005
-    // eslint-disable-next-line @typescript-eslint/max-params
     function send(_tr, _oldState, newState, sendAnalyticsEvent) {
       var unconfirmedStepsData = sendableSteps(newState);
       var version = this.getVersionFromCollabState(newState, 'collab-provider: send');
@@ -883,7 +883,9 @@ export var DocumentService = /*#__PURE__*/function () {
         onErrorHandled: this.onErrorHandled,
         analyticsHelper: this.analyticsHelper,
         emit: this.providerEmitCallback,
-        __livePage: this.options.__livePage
+        __livePage: this.options.__livePage,
+        hasRecovered: this.hasRecovered,
+        collabMode: this.participantsService.getCollabMode()
       });
     }
   }]);

package/dist/esm/helpers/utils.js

@@ -1,7 +1,11 @@
+import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import _regeneratorRuntime from "@babel/runtime/regenerator";
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 import { scrubAdf } from '@atlaskit/adf-utils/scrub';
+import { sendableSteps } from '@atlaskit/prosemirror-collab';
+import { CustomError } from '../errors/custom-errors';
 export var createLogger = function createLogger(prefix) {
   var color = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 'blue';
   return (
@@ -191,4 +195,77 @@ var stepToAdf = function stepToAdf(step) {
     });
   }
   return [];
-};
+};
+export function logObfuscatedSteps(_x, _x2) {
+  return _logObfuscatedSteps.apply(this, arguments);
+}
+function _logObfuscatedSteps() {
+  _logObfuscatedSteps = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(oldState, newState) {
+    var _states$new, _states$old, stepsFromOldState, stepsFromNewState, states;
+    return _regeneratorRuntime.wrap(function _callee$(_context) {
+      while (1) switch (_context.prev = _context.next) {
+        case 0:
+          _context.prev = 0;
+          stepsFromOldState = '', stepsFromNewState = '';
+          states = {
+            old: oldState ? sendableSteps(oldState) : null,
+            new: sendableSteps(newState)
+          };
+          if (!((_states$new = states.new) !== null && _states$new !== void 0 && _states$new.steps)) {
+            _context.next = 7;
+            break;
+          }
+          _context.next = 6;
+          return toObfuscatedSteps(states.new.steps);
+        case 6:
+          stepsFromNewState = _context.sent;
+        case 7:
+          if (!((_states$old = states.old) !== null && _states$old !== void 0 && _states$old.steps)) {
+            _context.next = 11;
+            break;
+          }
+          _context.next = 10;
+          return toObfuscatedSteps(states.old.steps);
+        case 10:
+          stepsFromOldState = _context.sent;
+        case 11:
+          return _context.abrupt("return", {
+            stepsFromOldState: stepsFromOldState,
+            stepsFromNewState: stepsFromNewState
+          });
+        case 14:
+          _context.prev = 14;
+          _context.t0 = _context["catch"](0);
+          return _context.abrupt("return", new CustomError('Failed to obfuscate steps', _context.t0));
+        case 17:
+        case "end":
+          return _context.stop();
+      }
+    }, _callee, null, [[0, 14]]);
+  }));
+  return _logObfuscatedSteps.apply(this, arguments);
+}
+export function toObfuscatedSteps(_x3) {
+  return _toObfuscatedSteps.apply(this, arguments);
+}
+function _toObfuscatedSteps() {
+  _toObfuscatedSteps = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2(steps) {
+    var _steps;
+    return _regeneratorRuntime.wrap(function _callee2$(_context2) {
+      while (1) switch (_context2.prev = _context2.next) {
+        case 0:
+          _context2.next = 2;
+          return Promise.resolve(steps.slice().map(function (s) {
+            return s.toJSON();
+          }));
+        case 2:
+          _steps = _context2.sent;
+          return _context2.abrupt("return", JSON.stringify(getObfuscatedSteps(_steps)));
+        case 4:
+        case "end":
+          return _context2.stop();
+      }
+    }, _callee2);
+  }));
+  return _toObfuscatedSteps.apply(this, arguments);
+}

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

@@ -24,8 +24,6 @@ var SEND_PRESENCE_INTERVAL = 150 * 1000; // 150 seconds
  * @param sendPresenceJoined Callback to Channel class
  */
 export var ParticipantsService = /*#__PURE__*/function () {
-  // Ignored via go/ees005
-  // eslint-disable-next-line @typescript-eslint/max-params
   function ParticipantsService(analyticsHelper) {
     var _this = this;
     var participantsState = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : new ParticipantsState();
@@ -390,6 +388,9 @@ export var ParticipantsService = /*#__PURE__*/function () {
     _defineProperty(this, "getAIProviderParticipants", function () {
       return _this.participantsState.getAIProviderParticipants();
     });
+    _defineProperty(this, "getCollabMode", function () {
+      return _this.participantsState.size() > 1 ? 'collab' : 'single';
+    });
     this.analyticsHelper = analyticsHelper;
     this.participantsState = participantsState;
     this.emit = emit;

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

@@ -20,7 +20,9 @@ export var commitStepQueue = function commitStepQueue(_ref) {
     onErrorHandled = _ref.onErrorHandled,
     analyticsHelper = _ref.analyticsHelper,
     emit = _ref.emit,
-    __livePage = _ref.__livePage;
+    __livePage = _ref.__livePage,
+    hasRecovered = _ref.hasRecovered,
+    collabMode = _ref.collabMode;
   if (!readyToCommit) {
     logger('Not ready to commit, skip');
     return;
@@ -62,6 +64,16 @@ export var commitStepQueue = function commitStepQueue(_ref) {
       return step;
     });
   }
+
+  // tag unconfirmed steps sent after page has been recovered during client's editing session
+  if (hasRecovered && fg('tag_unconfirmed_steps_after_recovery')) {
+    stepsWithClientAndUserId = stepsWithClientAndUserId.map(function (step) {
+      step.metadata = _objectSpread(_objectSpread({}, step.metadata), {}, {
+        unconfirmedStepAfterRecovery: true
+      });
+      return step;
+    });
+  }
   var start = new Date().getTime();
   emit('commit-status', {
     status: 'attempt',
@@ -69,6 +81,7 @@ export var commitStepQueue = function commitStepQueue(_ref) {
   });
   try {
     broadcast('steps:commit', {
+      collabMode: collabMode,
       steps: stepsWithClientAndUserId,
       version: version,
       userId: userId

package/dist/esm/provider/index.js

@@ -13,12 +13,13 @@ function _callSuper(t, o, e) { return o = _getPrototypeOf(o), _possibleConstruct
 function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
 function _superPropGet(t, o, e, r) { var p = _get(_getPrototypeOf(1 & r ? t.prototype : t), o, e); return 2 & r && "function" == typeof p ? function (t) { return p.apply(e, t); } : p; }
 import { v4 as uuidv4 } from 'uuid';
+import { fg } from '@atlaskit/platform-feature-flags';
 import { Emitter } from '../emitter';
 import { Channel } from '../channel';
-import { createLogger } from '../helpers/utils';
+import { createLogger, logObfuscatedSteps } from '../helpers/utils';
 import AnalyticsHelper from '../analytics/analytics-helper';
 import { telepointerCallback } from '../participants/telepointers-helper';
-import { DestroyError, GetCurrentStateError, GetFinalAcknowledgedStateError, ProviderInitialisationError, SendTransactionError, SetEditorWidthError, SetMetadataError, SetTitleError } from '../errors/custom-errors';
+import { CustomError, DestroyError, GetCurrentStateError, GetFinalAcknowledgedStateError, ProviderInitialisationError, SendTransactionError, SetEditorWidthError, SetMetadataError, SetTitleError } from '../errors/custom-errors';
 import { NCS_ERROR_CODE } from '../errors/ncs-errors';
 import { MetadataService } from '../metadata/metadata-service';
 import { DocumentService } from '../document/document-service';
@@ -155,7 +156,29 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
         _this.emit('permission', permit);
       }).on('steps:added', _this.documentService.onStepsAdded).on('metadata:changed', _this.metadataService.onMetadataChanged).on('participant:telepointer', function (payload) {
         return _this.participantsService.onParticipantTelepointer(payload, _this.sessionId);
-      }).on('participant:activity-join', _this.participantsService.onParticipantActivityJoin).on('participant:activity-ack', _this.participantsService.onParticipantActivityAck).on('presence:joined', _this.participantsService.onPresenceJoined).on('presence', _this.participantsService.onPresence).on('participant:left', _this.participantsService.onParticipantLeft).on('participant:updated', _this.participantsService.onParticipantUpdated).on('disconnect', _this.onDisconnected.bind(_this)).on('error', _this.onErrorHandled).on('status', _this.namespaceService.onNamespaceStatusChanged).connect(shouldSkipDocumentInit);
+      }).on('participant:activity-join', _this.participantsService.onParticipantActivityJoin).on('participant:activity-ack', _this.participantsService.onParticipantActivityAck).on('presence:joined', _this.participantsService.onPresenceJoined).on('presence', _this.participantsService.onPresence).on('participant:left', _this.participantsService.onParticipantLeft).on('participant:updated', _this.participantsService.onParticipantUpdated).on('disconnect', _this.onDisconnected.bind(_this)).on('error', _this.onErrorHandled).on('status', /*#__PURE__*/function () {
+        var _ref4 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(status) {
+          var isLocked;
+          return _regeneratorRuntime.wrap(function _callee$(_context) {
+            while (1) switch (_context.prev = _context.next) {
+              case 0:
+                _context.next = 2;
+                return _this.namespaceService.onNamespaceStatusChanged(status);
+              case 2:
+                isLocked = _this.namespaceService.getIsNamespaceLocked();
+                _this.emit('namespace-lock:check', {
+                  isLocked: isLocked
+                });
+              case 4:
+              case "end":
+                return _context.stop();
+            }
+          }, _callee);
+        }));
+        return function (_x) {
+          return _ref4.apply(this, arguments);
+        };
+      }()).connect(shouldSkipDocumentInit);
     });
     _defineProperty(_this, "setUserId", function (id) {
       _this.userId = id;
@@ -202,8 +225,8 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
       return _this.aiProviderActiveIds;
     });
     // Note: this gets triggered on page reload for Firefox (not other browsers) because of closeOnBeforeunload: false
-    _defineProperty(_this, "onDisconnected", function (_ref4) {
-      var reason = _ref4.reason;
+    _defineProperty(_this, "onDisconnected", function (_ref5) {
+      var reason = _ref5.reason;
       _this.disconnectedAt = Date.now();
       _this.participantsService.disconnect(reason, _this.sessionId);
     });
@@ -218,52 +241,52 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
      * Used for draft sync, a process running every 5s for the first editor of a document to sync the document to the Confluence back-end.
      * @throws {GetCurrentStateError} Something went wrong while returning the current state
      */
-    _defineProperty(_this, "getCurrentState", /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee() {
+    _defineProperty(_this, "getCurrentState", /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2() {
       var _this$analyticsHelper4;
-      return _regeneratorRuntime.wrap(function _callee$(_context) {
-        while (1) switch (_context.prev = _context.next) {
+      return _regeneratorRuntime.wrap(function _callee2$(_context2) {
+        while (1) switch (_context2.prev = _context2.next) {
           case 0:
-            _context.prev = 0;
-            _context.next = 3;
+            _context2.prev = 0;
+            _context2.next = 3;
             return _this.documentService.getCurrentState();
           case 3:
-            return _context.abrupt("return", _context.sent);
+            return _context2.abrupt("return", _context2.sent);
           case 6:
-            _context.prev = 6;
-            _context.t0 = _context["catch"](0);
-            (_this$analyticsHelper4 = _this.analyticsHelper) === null || _this$analyticsHelper4 === void 0 || _this$analyticsHelper4.sendErrorEvent(_context.t0, 'Error while returning ADF version of current draft document');
-            throw new GetCurrentStateError('Error while returning the current state of the draft document', _context.t0);
+            _context2.prev = 6;
+            _context2.t0 = _context2["catch"](0);
+            (_this$analyticsHelper4 = _this.analyticsHelper) === null || _this$analyticsHelper4 === void 0 || _this$analyticsHelper4.sendErrorEvent(_context2.t0, 'Error while returning ADF version of current draft document');
+            throw new GetCurrentStateError('Error while returning the current state of the draft document', _context2.t0);
           case 10:
           case "end":
-            return _context.stop();
+            return _context2.stop();
         }
-      }, _callee, null, [[0, 6]]);
+      }, _callee2, null, [[0, 6]]);
     })));
     /**
      * Return the final acknowledged (by NCS) ADF version of the current draft document, together with it's title and the current step version.
      * Used when returning the document to Confluence on publish.
      * @throws {GetFinalAcknowledgedStateError} Something went wrong while returning the acknowledged state
      */
-    _defineProperty(_this, "getFinalAcknowledgedState", /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2() {
+    _defineProperty(_this, "getFinalAcknowledgedState", /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee3() {
       var _this$analyticsHelper5;
-      return _regeneratorRuntime.wrap(function _callee2$(_context2) {
-        while (1) switch (_context2.prev = _context2.next) {
+      return _regeneratorRuntime.wrap(function _callee3$(_context3) {
+        while (1) switch (_context3.prev = _context3.next) {
           case 0:
-            _context2.prev = 0;
-            _context2.next = 3;
+            _context3.prev = 0;
+            _context3.next = 3;
             return _this.documentService.getFinalAcknowledgedState();
           case 3:
-            return _context2.abrupt("return", _context2.sent);
+            return _context3.abrupt("return", _context3.sent);
           case 6:
-            _context2.prev = 6;
-            _context2.t0 = _context2["catch"](0);
-            (_this$analyticsHelper5 = _this.analyticsHelper) === null || _this$analyticsHelper5 === void 0 || _this$analyticsHelper5.sendErrorEvent(_context2.t0, 'Error while returning ADF version of the final draft document');
-            throw new GetFinalAcknowledgedStateError('Error while returning the final acknowledged state of the draft document', _context2.t0);
+            _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 GetFinalAcknowledgedStateError('Error while returning the final acknowledged state of the draft document', _context3.t0);
           case 10:
           case "end":
-            return _context2.stop();
+            return _context3.stop();
         }
-      }, _callee2, null, [[0, 6]]);
+      }, _callee3, null, [[0, 6]]);
     })));
     _defineProperty(_this, "getUnconfirmedSteps", function () {
       return _this.documentService.getUnconfirmedSteps();
@@ -352,10 +375,10 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
      */
   }, {
     key: "setup",
-    value: function setup(_ref7) {
-      var getState = _ref7.getState,
-        editorApi = _ref7.editorApi,
-        onSyncUpError = _ref7.onSyncUpError;
+    value: function setup(_ref8) {
+      var getState = _ref8.getState,
+        editorApi = _ref8.editorApi,
+        onSyncUpError = _ref8.onSyncUpError;
       this.checkForCookies();
       try {
         // Ignored via go/ees005
@@ -449,16 +472,29 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
   }, {
     key: "send",
     value: function send(_tr, _oldState, newState) {
+      var _this2 = this;
       try {
         if (this.isViewOnly()) {
-          var _this$analyticsHelper10;
           var error = {
             message: 'Attempted to send steps in view only mode',
             data: {
               code: INTERNAL_ERROR_CODE.VIEW_ONLY_STEPS_ERROR
             }
           };
-          (_this$analyticsHelper10 = this.analyticsHelper) === null || _this$analyticsHelper10 === void 0 || _this$analyticsHelper10.sendErrorEvent(error, error.message);
+          if (fg('log_obfuscated_steps_for_view_only')) {
+            logObfuscatedSteps(_oldState, newState).then(function (attributes) {
+              var _this2$analyticsHelpe;
+              var stepAttributes = attributes instanceof CustomError ? {} : _objectSpread({}, attributes);
+              var stepsError = new CustomError(error.message, error, _objectSpread({}, stepAttributes));
+              (_this2$analyticsHelpe = _this2.analyticsHelper) === null || _this2$analyticsHelpe === void 0 || _this2$analyticsHelpe.sendErrorEvent(stepsError, stepsError.message);
+            }).catch(function (err) {
+              var _this2$analyticsHelpe2;
+              return (_this2$analyticsHelpe2 = _this2.analyticsHelper) === null || _this2$analyticsHelpe2 === void 0 ? void 0 : _this2$analyticsHelpe2.sendErrorEvent(err, err.message);
+            });
+          } else {
+            var _this$analyticsHelper10;
+            (_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)

package/dist/esm/version-wrapper.js

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

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

@@ -27,6 +27,7 @@ export declare class DocumentService implements DocumentServiceInterface {
     private stepRejectCounter;
     private aggressiveCatchup;
     private catchUpOutofSync;
+    private hasRecovered;
     private clientId?;
     onErrorHandled: (error: InternalError) => void;
     /**

package/dist/types/errors/custom-errors.d.ts

@@ -1,5 +1,5 @@
 import type { CantSyncUpErrorAttributes, DocumentUpdateErrorAttributes } from '../helpers/const';
-type ValidEventAttributeType = boolean | string | number;
+type ValidEventAttributeType = boolean | string | number | object;
 export declare class CustomError extends Error {
     extraEventAttributes?: {
         [key: string]: ValidEventAttributeType;

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

@@ -1,8 +1,10 @@
 import { type ADFEntity } from '@atlaskit/adf-utils/types';
 import type { ProductInformation } from '../types';
 import type { Step as ProseMirrorStep } from '@atlaskit/editor-prosemirror/transform';
+import type { EditorState } from '@atlaskit/editor-prosemirror/state';
 import type { StepJson } from '@atlaskit/editor-common/collab';
-import type { Node as ProseMirrorNode } from '@atlaskit/editor-prosemirror/model';
+import { Node as ProseMirrorNode } from '@atlaskit/editor-prosemirror/model';
+import { CustomError } from '../errors/custom-errors';
 export declare const createLogger: (prefix: string, color?: string) => (msg: string, data?: any) => void;
 export declare function sleep(ms: number): Promise<unknown>;
 export declare const isAIProviderID: (id: string) => boolean;
@@ -50,5 +52,11 @@ export declare const getObfuscatedSteps: (steps: StepJson[], endIndex?: number |
         traceId?: string | undefined;
         reqId?: string | undefined;
         schemaVersion?: string | undefined;
+        unconfirmedStepAfterRecovery?: boolean | undefined;
     } | undefined;
 }[];
+export declare function logObfuscatedSteps(oldState: EditorState | null, newState: EditorState): Promise<CustomError | {
+    stepsFromOldState: string;
+    stepsFromNewState: string;
+}>;
+export declare function toObfuscatedSteps(steps: readonly ProseMirrorStep[]): Promise<string>;

package/dist/types/index.d.ts

@@ -1,4 +1,4 @@
 export { Provider } from './provider';
 export type { CollabEventDisconnectedData, Socket } from './types';
-export type { NewCollabSyncUpErrorAttributes, ResolvedEditorState, CollabMetadataPayload, CollabEventInitData, CollabInitPayload, CollabEventConnectionData, CollabConnectedPayload, CollabDisconnectedPayload, CollabDataPayload, CollabActivityData, CollabTelepointerPayload, CollabPresencePayload, CollabLocalStepsPayload, CollabPermissionEventPayload, CollabEventRemoteData, CollabEventPresenceData, CollabActivityJoinPayload, CollabActivityAckPayload, CollabEventConnectingData, CollabEventTelepointerData, CollabSendableSelection, CollabParticipant, CollabEvents, SyncUpErrorFunction, CollabEditProvider, ProviderError, ProviderParticipant, CollabEventLocalStepData, UserPermitType, } from '@atlaskit/editor-common/collab';
+export type { NewCollabSyncUpErrorAttributes, ResolvedEditorState, CollabMetadataPayload, CollabEventInitData, CollabInitPayload, CollabEventConnectionData, CollabConnectedPayload, CollabDisconnectedPayload, CollabDataPayload, CollabActivityData, CollabTelepointerPayload, CollabPresencePayload, CollabLocalStepsPayload, CollabPermissionEventPayload, CollabEventRemoteData, CollabEventPresenceData, CollabActivityJoinPayload, CollabActivityAckPayload, CollabEventConnectingData, CollabEventTelepointerData, CollabSendableSelection, CollabParticipant, CollabEvents, SyncUpErrorFunction, CollabEditProvider, ProviderError, ProviderParticipant, CollabEventLocalStepData, UserPermitType, CollabNamespaceLockCheckPayload, } from '@atlaskit/editor-common/collab';
 export { PROVIDER_ERROR_CODE } from '@atlaskit/editor-common/collab';

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

@@ -119,4 +119,5 @@ export declare class ParticipantsService {
      */
     getParticipants: () => ProviderParticipant[];
     getAIProviderParticipants: () => ProviderParticipant[];
+    getCollabMode: () => "collab" | "single";
 }

package/dist/types/provider/commit-step.d.ts

@@ -5,7 +5,7 @@ import type AnalyticsHelper from '../analytics/analytics-helper';
 import type { InternalError } from '../errors/internal-errors';
 export declare let readyToCommit: boolean;
 export declare const RESET_READYTOCOMMIT_INTERVAL_MS = 5000;
-export declare const commitStepQueue: ({ broadcast, steps, version, userId, clientId, onStepsAdded, onErrorHandled, analyticsHelper, emit, __livePage, }: {
+export declare const commitStepQueue: ({ broadcast, steps, version, userId, clientId, onStepsAdded, onErrorHandled, analyticsHelper, emit, __livePage, hasRecovered, collabMode, }: {
     broadcast: <K extends keyof ChannelEvent>(type: K, data: Omit<ChannelEvent[K], 'timestamp'>, callback?: Function) => void;
     steps: readonly ProseMirrorStep[];
     version: number;
@@ -16,4 +16,6 @@ export declare const commitStepQueue: ({ broadcast, steps, version, userId, clie
     analyticsHelper?: AnalyticsHelper | undefined;
     emit: (evt: keyof CollabEvents, data: CollabCommitStatusEventPayload) => void;
     __livePage: boolean;
+    hasRecovered: boolean;
+    collabMode: string;
 }) => void;

package/dist/types/types.d.ts

@@ -188,6 +188,7 @@ export type ChannelEvent = {
     'participant:updated': PresencePayload;
     'steps:commit': StepsPayload & {
         userId: string;
+        collabMode: string;
     };
     'steps:added': StepsPayload;
     'metadata:changed': Metadata;

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

@@ -27,6 +27,7 @@ export declare class DocumentService implements DocumentServiceInterface {
     private stepRejectCounter;
     private aggressiveCatchup;
     private catchUpOutofSync;
+    private hasRecovered;
     private clientId?;
     onErrorHandled: (error: InternalError) => void;
     /**

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

@@ -1,5 +1,5 @@
 import type { CantSyncUpErrorAttributes, DocumentUpdateErrorAttributes } from '../helpers/const';
-type ValidEventAttributeType = boolean | string | number;
+type ValidEventAttributeType = boolean | string | number | object;
 export declare class CustomError extends Error {
     extraEventAttributes?: {
         [key: string]: ValidEventAttributeType;