@atlaskit/collab-provider 9.7.0 → 9.7.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @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

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/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.7.0";
+var version = "9.7.1";
 exports.version = version;
 var nextMajorVersion = function nextMajorVersion() {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/collab-provider",
-	"version": "9.7.0",
+	"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/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.7.0";
+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.7.0",
+	"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';

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