@atlaskit/collab-provider 9.6.4 → 9.7.1

package/dist/cjs/version.json

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

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

@@ -1,3 +1,5 @@
+import { DisconnectReason } from '@atlaskit/editor-common/collab';
+
 // See https://socket.io/docs/v3/client-socket-instance#disconnect for emitted reasons
 export const socketIOReasons = {
   IO_CLIENT_DISCONNECT: 'io client disconnect',
@@ -11,15 +13,6 @@ export const socketIOReasons = {
   PING_TIMEOUT: 'ping timeout' // The connection has encountered an error (example: the server was killed during a HTTP long-polling cycle)
 };
 
-export let 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;
-}({});
 export const disconnectedReasonMapper = reason => {
   switch (reason) {
     case socketIOReasons.IO_CLIENT_DISCONNECT:

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

@@ -1,5 +1,6 @@
 import { NCS_ERROR_CODE } from './error-types';
-import { INTERNAL_ERROR_CODE, PROVIDER_ERROR_CODE } from './error-types';
+import { INTERNAL_ERROR_CODE } from './error-types';
+import { PROVIDER_ERROR_CODE } from '@atlaskit/editor-common/collab';
 
 /*
  * Maps internal collab provider errors to an emitted error format

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

@@ -52,22 +52,6 @@ export let 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.
  */
-// Emitted errors
-export let 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 = {
@@ -83,84 +67,6 @@ export let 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.
- */
 // Custom Errors
 export class CustomError extends Error {
   constructor(message, error, extraEventAttributes) {

package/dist/es2019/index.js

@@ -1,2 +1,2 @@
 export { Provider } from './provider';
-export { PROVIDER_ERROR_CODE } from './errors/error-types';
+export { PROVIDER_ERROR_CODE } from '@atlaskit/editor-common/collab';

package/dist/es2019/provider/index.js

@@ -30,14 +30,39 @@ export class Provider extends Emitter {
      * @param data - Event data to emit to subscribers
      */
     _defineProperty(this, "emitCallback", (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(() => this.emit(evt, data));
+        this.onSetupPromise.then(() => 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(this, "updateDocumentAndMetadata", ({
+      doc,
+      version,
+      metadata
+    }) => {
+      try {
+        this.documentService.updateDocument({
+          doc,
+          version,
+          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(this, "initializeChannel", () => {
       this.emit('connecting', {
         initial: true
@@ -66,22 +91,24 @@ export class Provider extends Emitter {
               version,
               metadata
             } = this.initialDraft;
-            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(() => {
+                this.updateDocumentAndMetadata({
+                  doc: document,
+                  version,
+                  metadata
+                });
+              });
+            } else {
+              this.updateDocumentAndMetadata({
                 doc: document,
                 version,
                 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 &&
@@ -97,20 +124,11 @@ export class Provider extends Emitter {
         metadata
       }) => {
         // Initial document and version
-        try {
-          this.documentService.updateDocument({
-            doc,
-            version,
-            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,
+          version,
+          metadata
+        });
       }).on('restore', this.documentService.onRestore).on('steps:added', this.documentService.onStepsAdded).on('metadata:changed', this.metadataService.onMetadataChanged).on('participant:telepointer', payload => 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(this)).on('error', this.onErrorHandled).on('status', this.namespaceService.onNamespaceStatusChanged).connect(shouldInitialize);
     });
     _defineProperty(this, "setUserId", id => {
@@ -134,13 +152,13 @@ export class Provider extends 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');
         const 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);
         }
       }
@@ -167,8 +185,8 @@ export class Provider extends Emitter {
       try {
         return await this.documentService.getCurrentState();
       } catch (error) {
-        var _this$analyticsHelper5;
-        (_this$analyticsHelper5 = this.analyticsHelper) === null || _this$analyticsHelper5 === void 0 ? void 0 : _this$analyticsHelper5.sendErrorEvent(error, 'Error while returning ADF version of current draft document');
+        var _this$analyticsHelper4;
+        (_this$analyticsHelper4 = this.analyticsHelper) === null || _this$analyticsHelper4 === void 0 ? void 0 : _this$analyticsHelper4.sendErrorEvent(error, 'Error while returning ADF version of current draft document');
         throw new GetCurrentStateError('Error while returning the current state of the draft document', error); // Reject the promise so the consumer can react to it failing
       }
     });
@@ -181,8 +199,8 @@ export class Provider extends Emitter {
       try {
         return await this.documentService.getFinalAcknowledgedState();
       } catch (error) {
-        var _this$analyticsHelper6;
-        (_this$analyticsHelper6 = this.analyticsHelper) === null || _this$analyticsHelper6 === void 0 ? void 0 : _this$analyticsHelper6.sendErrorEvent(error, 'Error while returning ADF version of the final draft document');
+        var _this$analyticsHelper5;
+        (_this$analyticsHelper5 = this.analyticsHelper) === null || _this$analyticsHelper5 === void 0 ? void 0 : _this$analyticsHelper5.sendErrorEvent(error, 'Error while returning ADF version of the final draft document');
         throw new GetFinalAcknowledgedStateError('Error while returning the final acknowledged state of the draft document', error); // Reject the promise so the consumer can react to it failing
       }
     });
@@ -212,8 +230,8 @@ export class Provider extends Emitter {
     this.participantsService = new ParticipantsService(this.analyticsHelper, undefined, this.emitCallback, this.config.getUser, this.channel.broadcast, this.channel.sendPresenceJoined, this.getPresenceData, this.setUserId);
     this.metadataService = new MetadataService(this.emitCallback, this.channel.sendMetadata);
     this.documentService = new DocumentService(this.participantsService, this.analyticsHelper, this.channel.fetchCatchup, this.emitCallback, this.channel.broadcast, () => this.userId, this.onErrorHandled, this.metadataService, this.config.failedStepLimitBeforeCatchupOnPublish, this.config.enableErrorOnFailedDocumentApply);
-    this.getStatePromise = new Promise(resolve => {
-      this.getStatePromiseResolve = resolve;
+    this.onSetupPromise = new Promise(resolve => {
+      this.resolveOnSetupPromise = resolve;
     });
     this.namespaceService = new NamespaceService();
   }
@@ -247,16 +265,12 @@ export class Provider extends Emitter {
   }) {
     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();
-        }
         const collabPlugin = getState().plugins.find(p => p.key === 'collab$');
         if (collabPlugin === undefined) {
           throw new ProviderInitialisationError('Collab provider attempted to initialise, but Editor state is missing collab plugin');
@@ -267,14 +281,20 @@ export class Provider extends Emitter {
           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);
     }
@@ -282,9 +302,9 @@ export class Provider extends Emitter {
   }
   checkForCookies() {
     if (!global.navigator.cookieEnabled) {
-      var _this$analyticsHelper8;
+      var _this$analyticsHelper7;
       const 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);
     }
   }
@@ -318,8 +338,8 @@ export class Provider extends 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);
     }
   }
@@ -344,9 +364,9 @@ export class Provider extends 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');
     }
   }
   /**
@@ -378,8 +398,8 @@ export class Provider extends Emitter {
       super.unsubscribeAll();
       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();
@@ -397,8 +417,8 @@ export class Provider extends 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);
     }
   }
@@ -414,8 +434,8 @@ export class Provider extends 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);
     }
   }
@@ -429,8 +449,8 @@ export class Provider extends 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/es2019/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/es2019/version-wrapper.js

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

package/dist/es2019/version.json

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

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

@@ -1,3 +1,5 @@
+import { DisconnectReason } from '@atlaskit/editor-common/collab';
+
 // See https://socket.io/docs/v3/client-socket-instance#disconnect for emitted reasons
 export var socketIOReasons = {
   IO_CLIENT_DISCONNECT: 'io client disconnect',
@@ -11,15 +13,6 @@ export var socketIOReasons = {
   PING_TIMEOUT: 'ping timeout' // The connection has encountered an error (example: the server was killed during a HTTP long-polling cycle)
 };
 
-export 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;
-}({});
 export var disconnectedReasonMapper = function disconnectedReasonMapper(reason) {
   switch (reason) {
     case socketIOReasons.IO_CLIENT_DISCONNECT:

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

@@ -1,5 +1,6 @@
 import { NCS_ERROR_CODE } from './error-types';
-import { INTERNAL_ERROR_CODE, PROVIDER_ERROR_CODE } from './error-types';
+import { INTERNAL_ERROR_CODE } from './error-types';
+import { PROVIDER_ERROR_CODE } from '@atlaskit/editor-common/collab';
 
 /*
  * Maps internal collab provider errors to an emitted error format

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

@@ -61,22 +61,6 @@ export 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.
  */
-// Emitted errors
-export 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 = {
@@ -92,84 +76,6 @@ export 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.
- */
 // Custom Errors
 export var CustomError = /*#__PURE__*/function (_Error) {
   _inherits(CustomError, _Error);

package/dist/esm/index.js

@@ -1,2 +1,2 @@
 export { Provider } from './provider';
-export { PROVIDER_ERROR_CODE } from './errors/error-types';
+export { PROVIDER_ERROR_CODE } from '@atlaskit/editor-common/collab';