@atlaskit/collab-provider 9.6.4 → 9.7.1

package/dist/esm/provider/index.js

@@ -45,24 +45,48 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
      * @param data - Event data to emit to subscribers
      */
     _defineProperty(_assertThisInitialized(_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)
+     */
+    _defineProperty(_assertThisInitialized(_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();
+      }
+    });
     _defineProperty(_assertThisInitialized(_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,
@@ -81,22 +105,24 @@ export 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 &&
@@ -106,25 +132,16 @@ export 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(_assertThisInitialized(_this))).on('error', _this.onErrorHandled).on('status', _this.namespaceService.onNamespaceStatusChanged).connect(shouldInitialize);
@@ -150,20 +167,20 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
       if (((_error$data = error.data) === null || _error$data === void 0 ? void 0 : _error$data.code) === NCS_ERROR_CODE.HEAD_VERSION_UPDATE_FAILED || ((_error$data2 = error.data) === null || _error$data2 === void 0 ? void 0 : _error$data2.code) === 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 = 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
-    _defineProperty(_assertThisInitialized(_this), "onDisconnected", function (_ref3) {
-      var reason = _ref3.reason;
+    _defineProperty(_assertThisInitialized(_this), "onDisconnected", function (_ref4) {
+      var reason = _ref4.reason;
       _this.disconnectedAt = Date.now();
       _this.participantsService.disconnect(reason, _this.sessionId);
     });
@@ -179,7 +196,7 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
      * @throws {GetCurrentStateError} Something went wrong while returning the current state
      */
     _defineProperty(_assertThisInitialized(_this), "getCurrentState", /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee() {
-      var _this$analyticsHelper5;
+      var _this$analyticsHelper4;
       return _regeneratorRuntime.wrap(function _callee$(_context) {
         while (1) switch (_context.prev = _context.next) {
           case 0:
@@ -191,7 +208,7 @@ export 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 GetCurrentStateError('Error while returning the current state of the draft document', _context.t0);
           case 10:
           case "end":
@@ -205,7 +222,7 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
      * @throws {GetFinalAcknowledgedStateError} Something went wrong while returning the acknowledged state
      */
     _defineProperty(_assertThisInitialized(_this), "getFinalAcknowledgedState", /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2() {
-      var _this$analyticsHelper6;
+      var _this$analyticsHelper5;
       return _regeneratorRuntime.wrap(function _callee2$(_context2) {
         while (1) switch (_context2.prev = _context2.next) {
           case 0:
@@ -217,7 +234,7 @@ export 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 GetFinalAcknowledgedStateError('Error while returning the final acknowledged state of the draft document', _context2.t0);
           case 10:
           case "end":
@@ -253,8 +270,8 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
     _this.documentService = new 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();
     return _this;
@@ -288,21 +305,17 @@ export 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$';
           });
@@ -315,14 +328,20 @@ export 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 ProviderInitialisationError('Provider initialisation error', initError);
       }
@@ -332,9 +351,9 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
     key: "checkForCookies",
     value: function checkForCookies() {
       if (!global.navigator.cookieEnabled) {
-        var _this$analyticsHelper8;
+        var _this$analyticsHelper7;
         var initError = new 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 ProviderInitialisationError('Provider initialisation error - cookies disabled', initError);
       }
     }
@@ -372,8 +391,8 @@ export 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 SendTransactionError('Error while sending steps for a transaction', error);
       }
     }
@@ -401,9 +420,9 @@ export 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');
       }
     }
   }, {
@@ -442,8 +461,8 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
         _get(_getPrototypeOf(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 DestroyError('Error while shutting down the collab provider', error);
       }
       this.clearTimers();
@@ -463,8 +482,8 @@ export 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 SetTitleError('Error while setting title', error);
       }
     }
@@ -482,8 +501,8 @@ export 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 SetEditorWidthError('Error while setting editor width', error);
       }
     }
@@ -499,8 +518,8 @@ export 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 SetMetadataError('Error while setting metadata', error);
       }
     }

package/dist/esm/types.js

@@ -1,4 +1,4 @@
-// types from editor common
+// Re-export values for the /types entry point to this package
 
 // types from editor common end
 

package/dist/esm/version-wrapper.js

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

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/collab-provider",
-	"version": "9.6.4",
+	"version": "9.7.1",
 	"sideEffects": false
 }

package/dist/types/channel.d.ts

@@ -1,7 +1,8 @@
 import { Emitter } from './emitter';
-import type { Config, ChannelEvent, CatchupResponse, Metadata } from './types';
+import type { Config, ChannelEvent, CatchupResponse } from './types';
 import type { Socket } from 'socket.io-client';
 import AnalyticsHelper from './analytics/analytics-helper';
+import type { Metadata } from '@atlaskit/editor-common/collab';
 export declare class Channel extends Emitter<ChannelEvent> {
     private connected;
     private config;

package/dist/types/disconnected-reason-mapper.d.ts

@@ -1,3 +1,4 @@
+import { DisconnectReason } from '@atlaskit/editor-common/collab';
 export declare const socketIOReasons: {
     IO_CLIENT_DISCONNECT: string;
     IO_SERVER_DISCONNECT: string;
@@ -5,12 +6,4 @@ export declare const socketIOReasons: {
     TRANSPORT_ERROR: string;
     PING_TIMEOUT: string;
 };
-export declare enum DisconnectReason {
-    CLIENT_DISCONNECT = "CLIENT_DISCONNECT",
-    SERVER_DISCONNECT = "SERVER_DISCONNECT",
-    SOCKET_CLOSED = "SOCKET_CLOSED",
-    SOCKET_ERROR = "SOCKET_ERROR",
-    SOCKET_TIMEOUT = "SOCKET_TIMEOUT",
-    UNKNOWN_DISCONNECT = "UNKNOWN_DISCONNECT"
-}
 export declare const disconnectedReasonMapper: (reason: string) => DisconnectReason;

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

@@ -1,9 +1,10 @@
 /// <reference types="lodash" />
 import AnalyticsHelper from '../analytics/analytics-helper';
-import { CatchupResponse, ChannelEvent, CollabEvents, CollabInitPayload, ResolvedEditorState, StepsPayload } from '../types';
+import { CatchupResponse, ChannelEvent, StepsPayload } from '../types';
+import type { SyncUpErrorFunction, ResolvedEditorState } from '@atlaskit/editor-common/collab';
 import type { Step as ProseMirrorStep } from 'prosemirror-transform';
 import type { MetadataService } from '../metadata/metadata-service';
-import { SyncUpErrorFunction } from '../types';
+import type { CollabEvents, CollabInitPayload } from '@atlaskit/editor-common/collab';
 import type { EditorState, Transaction } from 'prosemirror-state';
 import { ParticipantsService } from '../participants/participants-service';
 import type { InternalError } from '../errors/error-types';

package/dist/types/errors/error-code-mapper.d.ts

@@ -1,2 +1,3 @@
-import { InternalError, ProviderError } from './error-types';
+import { InternalError } from './error-types';
+import { ProviderError } from '@atlaskit/editor-common/collab';
 export declare const errorCodeMapper: (error: InternalError) => ProviderError | undefined;

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

@@ -240,196 +240,6 @@ export type InternalDocumentUpdateFailure = {
  * A union of all possible internal errors, that are mapped to another error if being emitted to the editor.
  */
 export type InternalError = NCSErrors | DocumentRecoveryError | AddStepsError | CatchUpFailedError | TokenPermissionError | ReconnectionError | ConnectionError | ReconnectionNetworkError | DocumentNotFoundError | InternalDocumentUpdateFailure;
-export declare enum PROVIDER_ERROR_CODE {
-    NO_PERMISSION_ERROR = "NO_PERMISSION_ERROR",
-    INVALID_USER_TOKEN = "INVALID_USER_TOKEN",
-    DOCUMENT_NOT_FOUND = "DOCUMENT_NOT_FOUND",
-    LOCKED = "LOCKED",
-    FAIL_TO_SAVE = "FAIL_TO_SAVE",
-    DOCUMENT_RESTORE_ERROR = "DOCUMENT_RESTORE_ERROR",
-    INITIALISATION_ERROR = "INITIALISATION_ERROR",
-    NETWORK_ISSUE = "NETWORK_ISSUE",
-    INVALID_PROVIDER_CONFIGURATION = "INVALID_PROVIDER_CONFIGURATION",
-    INTERNAL_SERVICE_ERROR = "INTERNAL_SERVICE_ERROR",
-    DOCUMENT_UPDATE_ERROR = "DOCUMENT_UPDATE_ERROR"
-}
-/**
- * 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.
- */
-type InsufficientEditingPermission = {
-    code: PROVIDER_ERROR_CODE.NO_PERMISSION_ERROR;
-    message: string;
-    recoverable: boolean;
-    reason?: string;
-    /**
-     * @deprecated switch to using either the error code or the recoverable flag
-     */
-    status?: number;
-};
-/**
- * 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.
- */
-type InvalidUserToken = {
-    code: PROVIDER_ERROR_CODE.INVALID_USER_TOKEN;
-    message: string;
-    recoverable: boolean;
-    /**
-     * @deprecated switch to using either the error code or the recoverable flag
-     */
-    status?: number;
-};
-/**
- * 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.
- */
-type DocumentNotFound = {
-    code: PROVIDER_ERROR_CODE.DOCUMENT_NOT_FOUND;
-    message: string;
-    recoverable: boolean;
-    /**
-     * @deprecated switch to using either the error code or the recoverable flag
-     */
-    status?: number;
-};
-/**
- * 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.
- */
-type Locked = {
-    code: PROVIDER_ERROR_CODE.LOCKED;
-    message: string;
-    recoverable: boolean;
-    status?: number;
-};
-/**
- * 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.
- */
-type FailToSave = {
-    code: PROVIDER_ERROR_CODE.FAIL_TO_SAVE;
-    message: string;
-    recoverable: boolean;
-    /**
-     * @deprecated switch to using either the error code or the recoverable flag
-     */
-    status?: number;
-};
-/**
- * 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.
- */
-type DocumentNotRestore = {
-    code: PROVIDER_ERROR_CODE.DOCUMENT_RESTORE_ERROR;
-    message: string;
-    recoverable: boolean;
-    /**
-     * @deprecated switch to using either the error code or the recoverable flag
-     */
-    status?: number;
-};
-/**
- * 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.
- */
-type InitialisationError = {
-    code: PROVIDER_ERROR_CODE.INITIALISATION_ERROR;
-    message: string;
-    recoverable: boolean;
-    /**
-     * @deprecated switch to using either the error code or the recoverable flag
-     */
-    status?: number;
-};
-/**
- * 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.
- */
-type NetworkIssue = {
-    code: PROVIDER_ERROR_CODE.NETWORK_ISSUE;
-    message: string;
-    recoverable: boolean;
-    /**
-     * @deprecated switch to using either the error code or the recoverable flag
-     */
-    status?: number;
-};
-/**
- * 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.
- */
-type InvalidProviderConfiguration = {
-    code: PROVIDER_ERROR_CODE.INVALID_PROVIDER_CONFIGURATION;
-    message: string;
-    recoverable: boolean;
-    reason: string;
-    /**
-     * @deprecated switch to using either the error code or the recoverable flag
-     */
-    status?: number;
-};
-/**
- * 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.
- */
-type InternalServiceError = {
-    code: PROVIDER_ERROR_CODE.INTERNAL_SERVICE_ERROR;
-    message: string;
-    recoverable: boolean;
-    reason: string;
-    /**
-     * @deprecated switch to using either the error code or the recoverable flag
-     */
-    status?: number;
-};
-type ProviderDocumentUpdateError = {
-    code: PROVIDER_ERROR_CODE.DOCUMENT_UPDATE_ERROR;
-    message: 'The provider failed to apply changes to the editor';
-    recoverable: boolean;
-    /**
-     * @deprecated switch to using either the error code or the recoverable flag
-     */
-    status?: number;
-};
-/**
- * A union of all possible provider errors that can be emitted back to the editor.
- */
-export type ProviderError = InsufficientEditingPermission | InvalidUserToken | DocumentNotFound | Locked | FailToSave | DocumentNotRestore | InitialisationError | NetworkIssue | InvalidProviderConfiguration | InternalServiceError | ProviderDocumentUpdateError;
 type ValidEventAttributeType = boolean | string | number;
 export declare class CustomError extends Error {
     extraEventAttributes?: {

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

@@ -1,4 +1,4 @@
-import type { ProviderError } from '../errors/error-types';
+import type { ProviderError } from '@atlaskit/editor-common/collab';
 export declare enum EVENT_ACTION {
     CONNECTION = "connection",
     CATCHUP = "catchup",

package/dist/types/index.d.ts

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

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

@@ -1,4 +1,4 @@
-import type { Metadata, CollabEvents } from '../types';
+import type { Metadata, CollabEvents } from '@atlaskit/editor-common/collab';
 export declare class MetadataService {
     private providerEmitCallback;
     private broadcastMetadata;

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

@@ -1,10 +1,6 @@
-import type { CollabParticipant, PresencePayload } from '../types';
+import type { PresencePayload } from '../types';
+import type { ProviderParticipant } from '@atlaskit/editor-common/collab';
 export declare const PARTICIPANT_UPDATE_INTERVAL: number;
-export type ProviderParticipant = CollabParticipant & {
-    userId: string;
-    clientId: number | string;
-    email: string;
-};
 export type ParticipantsMap = Map<string, ProviderParticipant>;
 export type GetUserType = ((userId: string) => Promise<Pick<ProviderParticipant, 'name' | 'avatar' | 'userId' | 'email'>>) | undefined;
 export declare const createParticipantFromPayload: (payload: import("../types").PresenceData & {

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

@@ -1,5 +1,6 @@
 import AnalyticsHelper from '../analytics/analytics-helper';
-import type { CollabEventDisconnectedData, CollabEventPresenceData, CollabTelepointerPayload, ChannelEvent, PresenceData, PresencePayload, StepJson, TelepointerPayload } from '../types';
+import type { CollabEventDisconnectedData, ChannelEvent, PresenceData, PresencePayload, TelepointerPayload } from '../types';
+import { CollabEventPresenceData, CollabTelepointerPayload, StepJson } from '@atlaskit/editor-common/collab';
 import { GetUserType } from './participants-helper';
 import { ParticipantsState } from './participants-state';
 /**
@@ -95,5 +96,5 @@ export declare class ParticipantsService {
     /**
      *
      */
-    getParticipants: () => import("./participants-helper").ProviderParticipant[];
+    getParticipants: () => import("@atlaskit/editor-common/collab").ProviderParticipant[];
 }