@atlaskit/collab-provider 9.6.4 → 9.7.1

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/collab-provider
 
+## 9.7.1
+
+### Patch Changes
+
+- [`14224c3f8a4`](https://bitbucket.org/atlassian/atlassian-frontend/commits/14224c3f8a4) - [ED-18162] Move the collab provider types to the editor common package to avoid circular dependencies
+
+## 9.7.0
+
+### Minor Changes
+
+- [`3265cccb965`](https://bitbucket.org/atlassian/atlassian-frontend/commits/3265cccb965) - resolving editor state before updating document/metadata during early provider initialization
+
 ## 9.6.4
 
 ### Patch Changes

package/dist/cjs/disconnected-reason-mapper.js

@@ -3,7 +3,8 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.socketIOReasons = exports.disconnectedReasonMapper = exports.DisconnectReason = void 0;
+exports.socketIOReasons = exports.disconnectedReasonMapper = void 0;
+var _collab = require("@atlaskit/editor-common/collab");
 // See https://socket.io/docs/v3/client-socket-instance#disconnect for emitted reasons
 var socketIOReasons = {
   IO_CLIENT_DISCONNECT: 'io client disconnect',
@@ -17,30 +18,20 @@ var socketIOReasons = {
   PING_TIMEOUT: 'ping timeout' // The connection has encountered an error (example: the server was killed during a HTTP long-polling cycle)
 };
 exports.socketIOReasons = socketIOReasons;
-var DisconnectReason = /*#__PURE__*/function (DisconnectReason) {
-  DisconnectReason["CLIENT_DISCONNECT"] = "CLIENT_DISCONNECT";
-  DisconnectReason["SERVER_DISCONNECT"] = "SERVER_DISCONNECT";
-  DisconnectReason["SOCKET_CLOSED"] = "SOCKET_CLOSED";
-  DisconnectReason["SOCKET_ERROR"] = "SOCKET_ERROR";
-  DisconnectReason["SOCKET_TIMEOUT"] = "SOCKET_TIMEOUT";
-  DisconnectReason["UNKNOWN_DISCONNECT"] = "UNKNOWN_DISCONNECT";
-  return DisconnectReason;
-}({});
-exports.DisconnectReason = DisconnectReason;
 var disconnectedReasonMapper = function disconnectedReasonMapper(reason) {
   switch (reason) {
     case socketIOReasons.IO_CLIENT_DISCONNECT:
-      return DisconnectReason.CLIENT_DISCONNECT;
+      return _collab.DisconnectReason.CLIENT_DISCONNECT;
     case socketIOReasons.IO_SERVER_DISCONNECT:
-      return DisconnectReason.SERVER_DISCONNECT;
+      return _collab.DisconnectReason.SERVER_DISCONNECT;
     case socketIOReasons.TRANSPORT_CLOSED:
-      return DisconnectReason.SOCKET_CLOSED;
+      return _collab.DisconnectReason.SOCKET_CLOSED;
     case socketIOReasons.TRANSPORT_ERROR:
-      return DisconnectReason.SOCKET_ERROR;
+      return _collab.DisconnectReason.SOCKET_ERROR;
     case socketIOReasons.PING_TIMEOUT:
-      return DisconnectReason.SOCKET_TIMEOUT;
+      return _collab.DisconnectReason.SOCKET_TIMEOUT;
     default:
-      return DisconnectReason.UNKNOWN_DISCONNECT;
+      return _collab.DisconnectReason.UNKNOWN_DISCONNECT;
   }
 };
 exports.disconnectedReasonMapper = disconnectedReasonMapper;

package/dist/cjs/errors/error-code-mapper.js

@@ -5,6 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.errorCodeMapper = void 0;
 var _errorTypes = require("./error-types");
+var _collab = require("@atlaskit/editor-common/collab");
 /*
  * Maps internal collab provider errors to an emitted error format
  */
@@ -23,7 +24,7 @@ var errorCodeMapper = function errorCodeMapper(error) {
     case _errorTypes.NCS_ERROR_CODE.INSUFFICIENT_EDITING_PERMISSION:
     case _errorTypes.INTERNAL_ERROR_CODE.TOKEN_PERMISSION_ERROR:
       return {
-        code: _errorTypes.PROVIDER_ERROR_CODE.NO_PERMISSION_ERROR,
+        code: _collab.PROVIDER_ERROR_CODE.NO_PERMISSION_ERROR,
         message: 'User does not have permissions to access this document or document is not found',
         reason: error.data.meta.reason,
         recoverable: true,
@@ -31,14 +32,14 @@ var errorCodeMapper = function errorCodeMapper(error) {
       };
     case _errorTypes.NCS_ERROR_CODE.FORBIDDEN_USER_TOKEN:
       return {
-        code: _errorTypes.PROVIDER_ERROR_CODE.INVALID_USER_TOKEN,
+        code: _collab.PROVIDER_ERROR_CODE.INVALID_USER_TOKEN,
         message: 'The user token was invalid',
         recoverable: true,
         status: 403
       };
     case _errorTypes.INTERNAL_ERROR_CODE.DOCUMENT_NOT_FOUND:
       return {
-        code: _errorTypes.PROVIDER_ERROR_CODE.DOCUMENT_NOT_FOUND,
+        code: _collab.PROVIDER_ERROR_CODE.DOCUMENT_NOT_FOUND,
         message: 'The requested document is not found',
         recoverable: true,
         status: 404
@@ -46,41 +47,41 @@ var errorCodeMapper = function errorCodeMapper(error) {
     case _errorTypes.NCS_ERROR_CODE.TENANT_INSTANCE_MAINTENANCE:
     case _errorTypes.NCS_ERROR_CODE.LOCKED_DOCUMENT:
       return {
-        code: _errorTypes.PROVIDER_ERROR_CODE.LOCKED,
+        code: _collab.PROVIDER_ERROR_CODE.LOCKED,
         message: 'The document is currently not available, please try again later',
         recoverable: true
       };
     case _errorTypes.NCS_ERROR_CODE.DYNAMO_ERROR:
       return {
-        code: _errorTypes.PROVIDER_ERROR_CODE.FAIL_TO_SAVE,
+        code: _collab.PROVIDER_ERROR_CODE.FAIL_TO_SAVE,
         message: 'Collab service is not able to save changes',
         recoverable: false,
         status: 500
       };
     case _errorTypes.INTERNAL_ERROR_CODE.DOCUMENT_RESTORE_ERROR:
       return {
-        code: _errorTypes.PROVIDER_ERROR_CODE.DOCUMENT_RESTORE_ERROR,
+        code: _collab.PROVIDER_ERROR_CODE.DOCUMENT_RESTORE_ERROR,
         message: 'Collab service unable to restore document',
         recoverable: false,
         status: 500
       };
     case _errorTypes.NCS_ERROR_CODE.INIT_DATA_LOAD_FAILED:
       return {
-        code: _errorTypes.PROVIDER_ERROR_CODE.INITIALISATION_ERROR,
+        code: _collab.PROVIDER_ERROR_CODE.INITIALISATION_ERROR,
         message: "The initial document couldn't be loaded from the collab service",
         recoverable: false,
         status: 500
       };
     case _errorTypes.INTERNAL_ERROR_CODE.DOCUMENT_UPDATE_ERROR:
       return {
-        code: _errorTypes.PROVIDER_ERROR_CODE.DOCUMENT_UPDATE_ERROR,
+        code: _collab.PROVIDER_ERROR_CODE.DOCUMENT_UPDATE_ERROR,
         message: 'The provider failed to apply changes to the editor',
         recoverable: false,
         status: 500
       };
     case _errorTypes.INTERNAL_ERROR_CODE.RECONNECTION_NETWORK_ISSUE:
       return {
-        code: _errorTypes.PROVIDER_ERROR_CODE.NETWORK_ISSUE,
+        code: _collab.PROVIDER_ERROR_CODE.NETWORK_ISSUE,
         message: "Couldn't reconnect to the collab service due to network issues",
         recoverable: true,
         status: 500
@@ -90,7 +91,7 @@ var errorCodeMapper = function errorCodeMapper(error) {
     case _errorTypes.NCS_ERROR_CODE.INVALID_DOCUMENT_ARI:
     case _errorTypes.NCS_ERROR_CODE.INVALID_CLOUD_ID:
       return {
-        code: _errorTypes.PROVIDER_ERROR_CODE.INVALID_PROVIDER_CONFIGURATION,
+        code: _collab.PROVIDER_ERROR_CODE.INVALID_PROVIDER_CONFIGURATION,
         message: 'Invalid provider configuration',
         recoverable: false,
         reason: (_error$data2 = error.data) === null || _error$data2 === void 0 ? void 0 : _error$data2.code,
@@ -100,7 +101,7 @@ var errorCodeMapper = function errorCodeMapper(error) {
     case _errorTypes.NCS_ERROR_CODE.ERROR_MAPPING_ERROR:
     case _errorTypes.NCS_ERROR_CODE.EMPTY_BROADCAST:
       return {
-        code: _errorTypes.PROVIDER_ERROR_CODE.INTERNAL_SERVICE_ERROR,
+        code: _collab.PROVIDER_ERROR_CODE.INTERNAL_SERVICE_ERROR,
         message: 'Collab Provider experienced an unrecoverable error',
         recoverable: false,
         reason: (_error$data3 = error.data) === null || _error$data3 === void 0 ? void 0 : _error$data3.code,
@@ -108,7 +109,7 @@ var errorCodeMapper = function errorCodeMapper(error) {
       };
     case _errorTypes.INTERNAL_ERROR_CODE.CATCHUP_FAILED:
       return {
-        code: _errorTypes.PROVIDER_ERROR_CODE.INTERNAL_SERVICE_ERROR,
+        code: _collab.PROVIDER_ERROR_CODE.INTERNAL_SERVICE_ERROR,
         message: 'Collab Provider experienced an unrecoverable error',
         recoverable: true,
         reason: (_error$data4 = error.data) === null || _error$data4 === void 0 ? void 0 : _error$data4.code,

package/dist/cjs/errors/error-types.js

@@ -4,7 +4,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.UpdateDocumentError = exports.SetTitleError = exports.SetMetadataError = exports.SetEditorWidthError = exports.SendTransactionError = exports.ProviderInitialisationError = exports.PROVIDER_ERROR_CODE = exports.NotInitializedError = exports.NotConnectedError = exports.NCS_ERROR_CODE = exports.INTERNAL_ERROR_CODE = exports.GetFinalAcknowledgedStateError = exports.GetCurrentStateError = exports.DestroyError = exports.CustomError = exports.CantSyncUpError = void 0;
+exports.UpdateDocumentError = exports.SetTitleError = exports.SetMetadataError = exports.SetEditorWidthError = exports.SendTransactionError = exports.ProviderInitialisationError = exports.NotInitializedError = exports.NotConnectedError = exports.NCS_ERROR_CODE = exports.INTERNAL_ERROR_CODE = exports.GetFinalAcknowledgedStateError = exports.GetCurrentStateError = exports.DestroyError = exports.CustomError = exports.CantSyncUpError = void 0;
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
 var _assertThisInitialized2 = _interopRequireDefault(require("@babel/runtime/helpers/assertThisInitialized"));
@@ -63,22 +63,6 @@ var NCS_ERROR_CODE = /*#__PURE__*/function (NCS_ERROR_CODE) {
 /**
  * A union of all possible internal errors, that are mapped to another error if being emitted to the editor.
  */
-exports.NCS_ERROR_CODE = NCS_ERROR_CODE;
-// Emitted errors
-var PROVIDER_ERROR_CODE = /*#__PURE__*/function (PROVIDER_ERROR_CODE) {
-  PROVIDER_ERROR_CODE["NO_PERMISSION_ERROR"] = "NO_PERMISSION_ERROR";
-  PROVIDER_ERROR_CODE["INVALID_USER_TOKEN"] = "INVALID_USER_TOKEN";
-  PROVIDER_ERROR_CODE["DOCUMENT_NOT_FOUND"] = "DOCUMENT_NOT_FOUND";
-  PROVIDER_ERROR_CODE["LOCKED"] = "LOCKED";
-  PROVIDER_ERROR_CODE["FAIL_TO_SAVE"] = "FAIL_TO_SAVE";
-  PROVIDER_ERROR_CODE["DOCUMENT_RESTORE_ERROR"] = "DOCUMENT_RESTORE_ERROR";
-  PROVIDER_ERROR_CODE["INITIALISATION_ERROR"] = "INITIALISATION_ERROR";
-  PROVIDER_ERROR_CODE["NETWORK_ISSUE"] = "NETWORK_ISSUE";
-  PROVIDER_ERROR_CODE["INVALID_PROVIDER_CONFIGURATION"] = "INVALID_PROVIDER_CONFIGURATION";
-  PROVIDER_ERROR_CODE["INTERNAL_SERVICE_ERROR"] = "INTERNAL_SERVICE_ERROR";
-  PROVIDER_ERROR_CODE["DOCUMENT_UPDATE_ERROR"] = "DOCUMENT_UPDATE_ERROR";
-  return PROVIDER_ERROR_CODE;
-}({});
 /*
  * This is what a generic ProviderError type would look like:
  * type ProviderError = {
@@ -94,84 +78,7 @@ var PROVIDER_ERROR_CODE = /*#__PURE__*/function (PROVIDER_ERROR_CODE) {
  *   reason?: string;
  * }
  */
-/**
- * This occurs when the provided user token is considered invalid for the given document ARI.
- * It happens during initialisation of the provider.
- * It could mean the document has been deleted (hence not found).
- * @message Message returned to editor, i.e User does not have permissions to access this document or document is not found
- * @recoverable It is recoverable, as we will try to refresh the token.
- */
-/**
- * Similiar to InsufficientEditingPermission, but the user token is invalid because it has expired or been revoked.
- * It may also be an invalid token format.
- * This error is given to the provider by NCS.
- * @message Message returned to editor, i.e. The user token was invalid
- * @recoverable It is recoverable, as we will try to refresh the token.
- */
-/**
- * Document not found error, thrown when the provider is unable to find a document with the given ARI and user token.
- * It occurs during fetchCatchup, a function that fetches the latest document state during catchup.
- * We need to recieve a 404 from the document service to throw this error.
- * @message Message returned to editor, i.e. The requested document is not found
- * @recoverable It is recoverable, as the provider can try again later.
- */
-/**
- * This error is thrown when the document is locked by another user.
- * The error is passed to us by NCS.
- * @message Message returned to editor, i.e. The document is currently not available, please try again later
- * @recoverable It is recoverable, as the provider can try again later.
- */
-/**
- * This error is thrown when the provider is unable to save the document.
- * This can happen when the connection to dynamoDB is lost, or when we do not have sufficient permissions (DYNAMO ERROR).
- * This error is given to us by NCS.
- * @message Message returned to editor, i.e. Collab service is not able to save changes
- * @recoverable It is not recoverable, as we don't want the user to continue editing a document that is not being saved.
- */
-/**
- * This error is thrown when the provider is unable to restore the document.
- * It occurs during onRestore, a function that restores the document to a previous version and reapplies unconfirmed steps.
- * onRestore is called when page recovery has emitted an 'init' event on a page client is currently connected to.
- * It could mean we failed to update the page metadata, or we failed to reapply unconfirmed steps.
- * @message Message returned to editor, i.e. Collab service unable to restore document
- * @recoverable It is not recoverable, as the provider has no further options after this.
- * The user will need to refresh the page to try again.
- */
-/**
- * The initial document couldn't be loaded from the collab service.
- * This error is given to us by NCS.
- * It could indicate either a network issue, or an internal service error in NCS.
- * @message Message returned to editor, i.e. The initial document couldn't be loaded from the collab service
- * @recoverable It is not recoverable, as the provider cannot do anything to fix it.
- * The user will need to refresh the page to try again.
- */
-/**
- * Couldn't reconnect to the collab service (NCS) due to network issues.
- * NCS could be down, or the user could be offline. It's also possible the url is incorrect, or the user is behind a proxy blocking the connection.
- * Fired upon a reconnection attempt error (from Socket.IO Manager)
- * @message Message returned to editor, i.e. Couldn't reconnect to the collab service due to network issues
- * @recoverable It is recoverable, as the provider will try to reconnect.
- */
-/**
- * This error is thrown when the provider has an invalid configuration.
- * It could happen due to these errors from NCS:
- *  NAMESPACE_INVALID
-    INVALID_ACTIVATION_ID
-    INVALID_DOCUMENT_ARI
-    INVALID_CLOUD_ID
- * @message Message returned to editor, i.e. Invalid provider configuration
- * @recoverable It is not recoverable, as the provider cannot do anything to fix it.
- * The service using the provider will need to fix the configuration.
- */
-/**
- * This error is thrown when the provider encounters an internal service error, not otherwise accounted for.
- * @message Message returned to editor, i.e. Collab Provider experienced an unrecoverable error
- * @recoverable It is not recoverable, as the provider cannot do anything to fix it.
- */
-/**
- * A union of all possible provider errors that can be emitted back to the editor.
- */
-exports.PROVIDER_ERROR_CODE = PROVIDER_ERROR_CODE;
+exports.NCS_ERROR_CODE = NCS_ERROR_CODE;
 // Custom Errors
 var CustomError = /*#__PURE__*/function (_Error) {
   (0, _inherits2.default)(CustomError, _Error);

package/dist/cjs/index.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 Object.defineProperty(exports, "PROVIDER_ERROR_CODE", {
   enumerable: true,
   get: function get() {
-    return _errorTypes.PROVIDER_ERROR_CODE;
+    return _collab.PROVIDER_ERROR_CODE;
   }
 });
 Object.defineProperty(exports, "Provider", {
@@ -16,4 +16,4 @@ Object.defineProperty(exports, "Provider", {
   }
 });
 var _provider = require("./provider");
-var _errorTypes = require("./errors/error-types");
+var _collab = require("@atlaskit/editor-common/collab");

package/dist/cjs/provider/index.js

@@ -53,24 +53,48 @@ var Provider = /*#__PURE__*/function (_Emitter) {
      * @param data - Event data to emit to subscribers
      */
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "emitCallback", function (evt, data) {
-      // When the provider is initialized early, we want the editor state promise to resolve before emitting events
+      // When the provider is initialized early, we want to ensure the editor state exists after setup is called before emitting events
       // to ensure that it is ready to listen to the events fired by NCS
       if (_this.isPreinitializing) {
-        _this.getStatePromise.then(function () {
+        _this.onSetupPromise.then(function () {
           return _this.emit(evt, data);
         });
       } else {
         _this.emit(evt, data);
       }
     });
+    /**
+     * Wrapper to update document and metadata.
+     * Catches and logs any errors thrown by document service's updateDocument and updateMetadata methods and destroys the provider in case of errors.
+     * Passing the document, metadata, version (either from the initial draft or from collab service)
+     */
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "updateDocumentAndMetadata", function (_ref) {
+      var doc = _ref.doc,
+        version = _ref.version,
+        metadata = _ref.metadata;
+      try {
+        _this.documentService.updateDocument({
+          doc: doc,
+          version: version,
+          metadata: metadata
+        });
+        _this.metadataService.updateMetadata(metadata);
+        _this.isProviderInitialized = true;
+      } catch (e) {
+        var _this$analyticsHelper;
+        (_this$analyticsHelper = _this.analyticsHelper) === null || _this$analyticsHelper === void 0 ? void 0 : _this$analyticsHelper.sendErrorEvent(e, 'Failed to update with the init document, destroying provider');
+        // Stop events and connections to step us trying to talk to the backend with an invalid state.
+        _this.destroy();
+      }
+    });
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "initializeChannel", function () {
       _this.emit('connecting', {
         initial: true
       });
       var shouldInitialize = Boolean(_this.initialDraft) && !_this.isProviderInitialized;
-      _this.channel.on('connected', function (_ref) {
-        var sid = _ref.sid,
-          initialized = _ref.initialized;
+      _this.channel.on('connected', function (_ref2) {
+        var sid = _ref2.sid,
+          initialized = _ref2.initialized;
         _this.sessionId = sid;
         _this.emitCallback('connected', {
           sid: sid,
@@ -89,22 +113,24 @@ var Provider = /*#__PURE__*/function (_Emitter) {
               document = _this$initialDraft.document,
               version = _this$initialDraft.version,
               metadata = _this$initialDraft.metadata;
-            try {
-              // Initial document, version, metadata from initial draft
-              _this.documentService.updateDocument({
+            if (_this.isPreinitializing) {
+              // When the provider is initialized early, we wait until setup is called with a defined getState before the document is updated to ensure that the editor state exists
+              // The `isPreinitializing` check is an extra precaution behind a FF - if the state is already resolved, onSetupPromise will resolve immediately
+              _this.onSetupPromise.then(function () {
+                _this.updateDocumentAndMetadata({
+                  doc: document,
+                  version: version,
+                  metadata: metadata
+                });
+              });
+            } else {
+              _this.updateDocumentAndMetadata({
                 doc: document,
                 version: version,
                 metadata: metadata
               });
-            } catch (e) {
-              var _this$analyticsHelper;
-              (_this$analyticsHelper = _this.analyticsHelper) === null || _this$analyticsHelper === void 0 ? void 0 : _this$analyticsHelper.sendErrorEvent(e, 'Failed to update the document on reconnect, destroying provider');
-              // Stop events and connections to step us trying to talk to the backend with an invalid state.
-              _this.destroy();
             }
-            _this.metadataService.updateMetadata(metadata);
           }
-          _this.isProviderInitialized = true;
         }
         // If already initialized, `connected` means reconnected
         if (initialized && _this.disconnectedAt &&
@@ -114,25 +140,16 @@ var Provider = /*#__PURE__*/function (_Emitter) {
         }
         _this.participantsService.startInactiveRemover(_this.sessionId);
         _this.disconnectedAt = undefined;
-      }).on('init', function (_ref2) {
-        var doc = _ref2.doc,
-          version = _ref2.version,
-          metadata = _ref2.metadata;
+      }).on('init', function (_ref3) {
+        var doc = _ref3.doc,
+          version = _ref3.version,
+          metadata = _ref3.metadata;
         // Initial document and version
-        try {
-          _this.documentService.updateDocument({
-            doc: doc,
-            version: version,
-            metadata: metadata
-          });
-          _this.metadataService.updateMetadata(metadata);
-          _this.isProviderInitialized = true;
-        } catch (e) {
-          var _this$analyticsHelper2;
-          (_this$analyticsHelper2 = _this.analyticsHelper) === null || _this$analyticsHelper2 === void 0 ? void 0 : _this$analyticsHelper2.sendErrorEvent(e, 'Failed to update with the init document, destroying provider');
-          // Stop events and connections to step us trying to talk to the backend with an invalid state.
-          _this.destroy();
-        }
+        _this.updateDocumentAndMetadata({
+          doc: doc,
+          version: version,
+          metadata: metadata
+        });
       }).on('restore', _this.documentService.onRestore).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('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((0, _assertThisInitialized2.default)(_this))).on('error', _this.onErrorHandled).on('status', _this.namespaceService.onNamespaceStatusChanged).connect(shouldInitialize);
@@ -158,20 +175,20 @@ var Provider = /*#__PURE__*/function (_Emitter) {
       if (((_error$data = error.data) === null || _error$data === void 0 ? void 0 : _error$data.code) === _errorTypes.NCS_ERROR_CODE.HEAD_VERSION_UPDATE_FAILED || ((_error$data2 = error.data) === null || _error$data2 === void 0 ? void 0 : _error$data2.code) === _errorTypes.NCS_ERROR_CODE.VERSION_NUMBER_ALREADY_EXISTS) {
         _this.documentService.onStepRejectedError();
       } else {
-        var _this$analyticsHelper3;
-        (_this$analyticsHelper3 = _this.analyticsHelper) === null || _this$analyticsHelper3 === void 0 ? void 0 : _this$analyticsHelper3.sendErrorEvent(error, 'Error handled');
+        var _this$analyticsHelper2;
+        (_this$analyticsHelper2 = _this.analyticsHelper) === null || _this$analyticsHelper2 === void 0 ? void 0 : _this$analyticsHelper2.sendErrorEvent(error, 'Error handled');
         var mappedError = (0, _errorCodeMapper.errorCodeMapper)(error);
         // Temporarily only emit errors to Confluence very intentionally because they will disconnect the collab provider
         if (mappedError) {
-          var _this$analyticsHelper4;
-          (_this$analyticsHelper4 = _this.analyticsHelper) === null || _this$analyticsHelper4 === void 0 ? void 0 : _this$analyticsHelper4.sendErrorEvent(mappedError, 'Error emitted');
+          var _this$analyticsHelper3;
+          (_this$analyticsHelper3 = _this.analyticsHelper) === null || _this$analyticsHelper3 === void 0 ? void 0 : _this$analyticsHelper3.sendErrorEvent(mappedError, 'Error emitted');
           _this.emitCallback('error', mappedError);
         }
       }
     });
     // Note: this gets triggered on page reload for Firefox (not other browsers) because of closeOnBeforeunload: false
-    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "onDisconnected", function (_ref3) {
-      var reason = _ref3.reason;
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "onDisconnected", function (_ref4) {
+      var reason = _ref4.reason;
       _this.disconnectedAt = Date.now();
       _this.participantsService.disconnect(reason, _this.sessionId);
     });
@@ -187,7 +204,7 @@ var Provider = /*#__PURE__*/function (_Emitter) {
      * @throws {GetCurrentStateError} Something went wrong while returning the current state
      */
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "getCurrentState", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
-      var _this$analyticsHelper5;
+      var _this$analyticsHelper4;
       return _regenerator.default.wrap(function _callee$(_context) {
         while (1) switch (_context.prev = _context.next) {
           case 0:
@@ -199,7 +216,7 @@ var Provider = /*#__PURE__*/function (_Emitter) {
           case 6:
             _context.prev = 6;
             _context.t0 = _context["catch"](0);
-            (_this$analyticsHelper5 = _this.analyticsHelper) === null || _this$analyticsHelper5 === void 0 ? void 0 : _this$analyticsHelper5.sendErrorEvent(_context.t0, 'Error while returning ADF version of current draft document');
+            (_this$analyticsHelper4 = _this.analyticsHelper) === null || _this$analyticsHelper4 === void 0 ? void 0 : _this$analyticsHelper4.sendErrorEvent(_context.t0, 'Error while returning ADF version of current draft document');
             throw new _errorTypes.GetCurrentStateError('Error while returning the current state of the draft document', _context.t0);
           case 10:
           case "end":
@@ -213,7 +230,7 @@ var Provider = /*#__PURE__*/function (_Emitter) {
      * @throws {GetFinalAcknowledgedStateError} Something went wrong while returning the acknowledged state
      */
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "getFinalAcknowledgedState", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2() {
-      var _this$analyticsHelper6;
+      var _this$analyticsHelper5;
       return _regenerator.default.wrap(function _callee2$(_context2) {
         while (1) switch (_context2.prev = _context2.next) {
           case 0:
@@ -225,7 +242,7 @@ var Provider = /*#__PURE__*/function (_Emitter) {
           case 6:
             _context2.prev = 6;
             _context2.t0 = _context2["catch"](0);
-            (_this$analyticsHelper6 = _this.analyticsHelper) === null || _this$analyticsHelper6 === void 0 ? void 0 : _this$analyticsHelper6.sendErrorEvent(_context2.t0, 'Error while returning ADF version of the final draft document');
+            (_this$analyticsHelper5 = _this.analyticsHelper) === null || _this$analyticsHelper5 === void 0 ? void 0 : _this$analyticsHelper5.sendErrorEvent(_context2.t0, 'Error while returning ADF version of the final draft document');
             throw new _errorTypes.GetFinalAcknowledgedStateError('Error while returning the final acknowledged state of the draft document', _context2.t0);
           case 10:
           case "end":
@@ -261,8 +278,8 @@ var Provider = /*#__PURE__*/function (_Emitter) {
     _this.documentService = new _documentService.DocumentService(_this.participantsService, _this.analyticsHelper, _this.channel.fetchCatchup, _this.emitCallback, _this.channel.broadcast, function () {
       return _this.userId;
     }, _this.onErrorHandled, _this.metadataService, _this.config.failedStepLimitBeforeCatchupOnPublish, _this.config.enableErrorOnFailedDocumentApply);
-    _this.getStatePromise = new Promise(function (resolve) {
-      _this.getStatePromiseResolve = resolve;
+    _this.onSetupPromise = new Promise(function (resolve) {
+      _this.resolveOnSetupPromise = resolve;
     });
     _this.namespaceService = new _namespaceService.NamespaceService();
     return _this;
@@ -296,21 +313,17 @@ var Provider = /*#__PURE__*/function (_Emitter) {
      */
   }, {
     key: "setup",
-    value: function setup(_ref6) {
-      var getState = _ref6.getState,
-        onSyncUpError = _ref6.onSyncUpError;
+    value: function setup(_ref7) {
+      var getState = _ref7.getState,
+        onSyncUpError = _ref7.onSyncUpError;
       this.checkForCookies();
       try {
-        // if setup is called with no state and the initial draft is already provided
+        // if setup is called with no getState and the initial draft is already provided
         // set a flag to mark early provider setup
         if (!getState && this.initialDraft) {
           this.isPreinitializing = true;
         }
         if (getState) {
-          // if provider has already been initialized earlier, resolve the state once it is available
-          if (this.isPreinitializing) {
-            this.getStatePromiseResolve();
-          }
           var collabPlugin = getState().plugins.find(function (p) {
             return p.key === 'collab$';
           });
@@ -323,14 +336,20 @@ var Provider = /*#__PURE__*/function (_Emitter) {
             onSyncUpError: onSyncUpError,
             clientId: this.clientId
           });
+
+          // if provider has already been initialized earlier, resolve the setup promise once setup has been called with
+          // a defined getState (ie editor state is ready) AND after documentService sets the editor state
+          if (this.isPreinitializing) {
+            this.resolveOnSetupPromise();
+          }
         }
         if (!this.isChannelInitialized) {
           this.initializeChannel();
           this.isChannelInitialized = true;
         }
       } catch (initError) {
-        var _this$analyticsHelper7;
-        (_this$analyticsHelper7 = this.analyticsHelper) === null || _this$analyticsHelper7 === void 0 ? void 0 : _this$analyticsHelper7.sendErrorEvent(initError, 'Error while initialising the provider');
+        var _this$analyticsHelper6;
+        (_this$analyticsHelper6 = this.analyticsHelper) === null || _this$analyticsHelper6 === void 0 ? void 0 : _this$analyticsHelper6.sendErrorEvent(initError, 'Error while initialising the provider');
         // Throw error so consumers are aware the initialisation failed when initialising themselves
         throw new _errorTypes.ProviderInitialisationError('Provider initialisation error', initError);
       }
@@ -340,9 +359,9 @@ var Provider = /*#__PURE__*/function (_Emitter) {
     key: "checkForCookies",
     value: function checkForCookies() {
       if (!global.navigator.cookieEnabled) {
-        var _this$analyticsHelper8;
+        var _this$analyticsHelper7;
         var initError = new _errorTypes.ProviderInitialisationError('Cookies are not enabled. Please enable cookies to use collaborative editing.');
-        (_this$analyticsHelper8 = this.analyticsHelper) === null || _this$analyticsHelper8 === void 0 ? void 0 : _this$analyticsHelper8.sendErrorEvent(initError, 'Error while initialising the provider - cookies disabled');
+        (_this$analyticsHelper7 = this.analyticsHelper) === null || _this$analyticsHelper7 === void 0 ? void 0 : _this$analyticsHelper7.sendErrorEvent(initError, 'Error while initialising the provider - cookies disabled');
         throw new _errorTypes.ProviderInitialisationError('Provider initialisation error - cookies disabled', initError);
       }
     }
@@ -380,8 +399,8 @@ var Provider = /*#__PURE__*/function (_Emitter) {
         }
         this.documentService.send(_tr, _oldState, newState);
       } catch (error) {
-        var _this$analyticsHelper9;
-        (_this$analyticsHelper9 = this.analyticsHelper) === null || _this$analyticsHelper9 === void 0 ? void 0 : _this$analyticsHelper9.sendErrorEvent(error, 'Error while sending steps for a transaction');
+        var _this$analyticsHelper8;
+        (_this$analyticsHelper8 = this.analyticsHelper) === null || _this$analyticsHelper8 === void 0 ? void 0 : _this$analyticsHelper8.sendErrorEvent(error, 'Error while sending steps for a transaction');
         throw new _errorTypes.SendTransactionError('Error while sending steps for a transaction', error);
       }
     }
@@ -409,9 +428,9 @@ var Provider = /*#__PURE__*/function (_Emitter) {
           this.channel.broadcast('participant:telepointer', payload, callback);
         }
       } catch (error) {
-        var _this$analyticsHelper10;
+        var _this$analyticsHelper9;
         // We don't want to throw errors for Presence features as they tend to self-restore
-        (_this$analyticsHelper10 = this.analyticsHelper) === null || _this$analyticsHelper10 === void 0 ? void 0 : _this$analyticsHelper10.sendErrorEvent(error, 'Error while sending message - telepointer');
+        (_this$analyticsHelper9 = this.analyticsHelper) === null || _this$analyticsHelper9 === void 0 ? void 0 : _this$analyticsHelper9.sendErrorEvent(error, 'Error while sending message - telepointer');
       }
     }
   }, {
@@ -450,8 +469,8 @@ var Provider = /*#__PURE__*/function (_Emitter) {
         (0, _get2.default)((0, _getPrototypeOf2.default)(Provider.prototype), "unsubscribeAll", this).call(this);
         this.channel.disconnect();
       } catch (error) {
-        var _this$analyticsHelper11;
-        (_this$analyticsHelper11 = this.analyticsHelper) === null || _this$analyticsHelper11 === void 0 ? void 0 : _this$analyticsHelper11.sendErrorEvent(error, 'Error while shutting down the collab provider');
+        var _this$analyticsHelper10;
+        (_this$analyticsHelper10 = this.analyticsHelper) === null || _this$analyticsHelper10 === void 0 ? void 0 : _this$analyticsHelper10.sendErrorEvent(error, 'Error while shutting down the collab provider');
         throw new _errorTypes.DestroyError('Error while shutting down the collab provider', error);
       }
       this.clearTimers();
@@ -471,8 +490,8 @@ var Provider = /*#__PURE__*/function (_Emitter) {
       try {
         this.metadataService.setTitle(title, broadcast);
       } catch (error) {
-        var _this$analyticsHelper12;
-        (_this$analyticsHelper12 = this.analyticsHelper) === null || _this$analyticsHelper12 === void 0 ? void 0 : _this$analyticsHelper12.sendErrorEvent(error, 'Error while setting title');
+        var _this$analyticsHelper11;
+        (_this$analyticsHelper11 = this.analyticsHelper) === null || _this$analyticsHelper11 === void 0 ? void 0 : _this$analyticsHelper11.sendErrorEvent(error, 'Error while setting title');
         throw new _errorTypes.SetTitleError('Error while setting title', error);
       }
     }
@@ -490,8 +509,8 @@ var Provider = /*#__PURE__*/function (_Emitter) {
       try {
         this.metadataService.setEditorWidth(editorWidth, broadcast);
       } catch (error) {
-        var _this$analyticsHelper13;
-        (_this$analyticsHelper13 = this.analyticsHelper) === null || _this$analyticsHelper13 === void 0 ? void 0 : _this$analyticsHelper13.sendErrorEvent(error, 'Error while setting editor width');
+        var _this$analyticsHelper12;
+        (_this$analyticsHelper12 = this.analyticsHelper) === null || _this$analyticsHelper12 === void 0 ? void 0 : _this$analyticsHelper12.sendErrorEvent(error, 'Error while setting editor width');
         throw new _errorTypes.SetEditorWidthError('Error while setting editor width', error);
       }
     }
@@ -507,8 +526,8 @@ var Provider = /*#__PURE__*/function (_Emitter) {
       try {
         this.metadataService.setMetadata(metadata);
       } catch (error) {
-        var _this$analyticsHelper14;
-        (_this$analyticsHelper14 = this.analyticsHelper) === null || _this$analyticsHelper14 === void 0 ? void 0 : _this$analyticsHelper14.sendErrorEvent(error, 'Error while setting metadata');
+        var _this$analyticsHelper13;
+        (_this$analyticsHelper13 = this.analyticsHelper) === null || _this$analyticsHelper13 === void 0 ? void 0 : _this$analyticsHelper13.sendErrorEvent(error, 'Error while setting metadata');
         throw new _errorTypes.SetMetadataError('Error while setting metadata', error);
       }
     }

package/dist/cjs/types.js

@@ -4,7 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.AcknowledgementResponseTypes = void 0;
-// types from editor common
+// Re-export values for the /types entry point to this package
 // types from editor common end
 // Initial draft
 // Channel

package/dist/cjs/version-wrapper.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.version = exports.nextMajorVersion = exports.name = void 0;
 var name = "@atlaskit/collab-provider";
 exports.name = name;
-var version = "9.6.4";
+var version = "9.7.1";
 exports.version = version;
 var nextMajorVersion = function nextMajorVersion() {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');