@atlaskit/collab-provider 9.18.0 → 9.18.2

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/collab-provider
 
+## 9.18.2
+
+### Patch Changes
+
+- [#58763](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/58763) [`0fdbd64522bf`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/0fdbd64522bf) - update ADF schema
+
+## 9.18.1
+
+### Patch Changes
+
+- [#58105](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/58105) [`515950be7f0b`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/515950be7f0b) - Split errors into multiple files
+
 ## 9.18.0
 
 ### Minor Changes

package/dist/cjs/analytics/analytics-helper.js

@@ -13,7 +13,7 @@ var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/de
 var _const = require("../helpers/const");
 var _versionWrapper = require("../version-wrapper");
 var _singleton = require("../connectivity/singleton");
-var _errorTypes = require("../errors/error-types");
+var _customErrors = require("../errors/custom-errors");
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 var EVENT_SUBJECT = 'collab';
@@ -78,7 +78,7 @@ var AnalyticsHelper = exports.default = /*#__PURE__*/function () {
     value: function sendErrorEvent(error, errorMessage) {
       var _data$code, _data, _data$status, _data2;
       var errorExtraAttributes = {};
-      if (error instanceof _errorTypes.CustomError) {
+      if (error instanceof _customErrors.CustomError) {
         errorExtraAttributes = error.getExtraErrorEventAttributes() || {};
       }
       var errorAnalyticsEvent = {

package/dist/cjs/channel.js

@@ -23,7 +23,9 @@ var _reconnectHelper = _interopRequireDefault(require("./connectivity/reconnect-
 var _ufo = require("./analytics/ufo");
 var _disconnectedReasonMapper = require("./disconnected-reason-mapper");
 var _network = _interopRequireDefault(require("./connectivity/network"));
-var _errorTypes = require("./errors/error-types");
+var _internalErrors = require("./errors/internal-errors");
+var _ncsErrors = require("./errors/ncs-errors");
+var _customErrors = require("./errors/custom-errors");
 var _socketMessageMetrics = require("./helpers/socket-message-metrics");
 var _featureFlags = require("./feature-flags");
 function _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e) { throw _e; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e2) { didErr = true; err = _e2; }, f: function f() { try { if (!normalCompletion && it.return != null) it.return(); } finally { if (didErr) throw err; } } }; }
@@ -116,7 +118,7 @@ var Channel = exports.Channel = /*#__PURE__*/function (_Emitter) {
         message: (_message = error.message) !== null && _message !== void 0 ? _message : 'Connection error without message',
         data: _objectSpread({
           // @ts-expect-error I bet we'll see some connection errors, for the Socket IO errors
-          code: (_errorData$code = errorData === null || errorData === void 0 ? void 0 : errorData.code) !== null && _errorData$code !== void 0 ? _errorData$code : _errorTypes.INTERNAL_ERROR_CODE.CONNECTION_ERROR
+          code: (_errorData$code = errorData === null || errorData === void 0 ? void 0 : errorData.code) !== null && _errorData$code !== void 0 ? _errorData$code : _internalErrors.INTERNAL_ERROR_CODE.CONNECTION_ERROR
         }, errorData)
       };
       _this.emit('error', connectionError);
@@ -130,7 +132,7 @@ var Channel = exports.Channel = /*#__PURE__*/function (_Emitter) {
         var reconnectionError = {
           message: 'Reconnection failed 8 times when browser was offline, likely there was a network issue',
           data: {
-            code: _errorTypes.INTERNAL_ERROR_CODE.RECONNECTION_NETWORK_ISSUE
+            code: _internalErrors.INTERNAL_ERROR_CODE.RECONNECTION_NETWORK_ISSUE
           }
         };
         _this.emit('error', reconnectionError);
@@ -305,7 +307,7 @@ var Channel = exports.Channel = /*#__PURE__*/function (_Emitter) {
                 message: 'The requested document is not found',
                 data: {
                   status: _context.t20.code,
-                  code: _errorTypes.INTERNAL_ERROR_CODE.DOCUMENT_NOT_FOUND
+                  code: _internalErrors.INTERNAL_ERROR_CODE.DOCUMENT_NOT_FOUND
                 }
               };
               _this.emit('error', errorNotFound);
@@ -318,7 +320,7 @@ var Channel = exports.Channel = /*#__PURE__*/function (_Emitter) {
                 message: 'Cannot fetch catchup from collab service',
                 data: {
                   status: _context.t20.status,
-                  code: _errorTypes.INTERNAL_ERROR_CODE.CATCHUP_FAILED
+                  code: _internalErrors.INTERNAL_ERROR_CODE.CATCHUP_FAILED
                 }
               };
               _this.emit('error', errorCatchup);
@@ -446,11 +448,11 @@ var Channel = exports.Channel = /*#__PURE__*/function (_Emitter) {
      */
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "broadcast", function (type, data, callback) {
       if (!_this.socket) {
-        throw new _errorTypes.NotInitializedError('Cannot broadcast, not initialized yet');
+        throw new _customErrors.NotInitializedError('Cannot broadcast, not initialized yet');
       }
       if (!_this.connected) {
         if (_this.config.throwOnNotConnected) {
-          throw new _errorTypes.NotConnectedError('Cannot broadcast, currently offline.');
+          throw new _customErrors.NotConnectedError('Cannot broadcast, currently offline.');
         }
         return;
       }
@@ -465,11 +467,11 @@ var Channel = exports.Channel = /*#__PURE__*/function (_Emitter) {
      */
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "sendMetadata", function (metadata) {
       if (!_this.socket) {
-        throw new _errorTypes.NotInitializedError('Cannot send metadata, not initialized yet');
+        throw new _customErrors.NotInitializedError('Cannot send metadata, not initialized yet');
       }
       if (!_this.connected) {
         if (_this.config.throwOnNotConnected) {
-          throw new _errorTypes.NotConnectedError('Cannot send metadata, currently offline.');
+          throw new _customErrors.NotConnectedError('Cannot send metadata, currently offline.');
         }
       }
       _this.socket.emit('metadata', metadata);
@@ -568,7 +570,7 @@ var Channel = exports.Channel = /*#__PURE__*/function (_Emitter) {
                     message: 'Insufficient editing permissions',
                     data: {
                       status: 403,
-                      code: _errorTypes.INTERNAL_ERROR_CODE.TOKEN_PERMISSION_ERROR,
+                      code: _internalErrors.INTERNAL_ERROR_CODE.TOKEN_PERMISSION_ERROR,
                       meta: {
                         originalError: _context3.t0,
                         reason: _context3.t0 === null || _context3.t0 === void 0 || (_data = _context3.t0.data) === null || _data === void 0 || (_data = _data.meta) === null || _data === void 0 ? void 0 : _data.reason // Should always be 'RESOURCE_DELETED' Temporary, until Confluence Cloud removes their hack
@@ -672,7 +674,7 @@ var Channel = exports.Channel = /*#__PURE__*/function (_Emitter) {
                       message: 'Caught error during reconnection',
                       data: {
                         status: 500,
-                        code: _errorTypes.INTERNAL_ERROR_CODE.RECONNECTION_ERROR
+                        code: _internalErrors.INTERNAL_ERROR_CODE.RECONNECTION_ERROR
                       }
                     };
                     _this2.emit('error', reconnectionError);
@@ -761,7 +763,7 @@ var Channel = exports.Channel = /*#__PURE__*/function (_Emitter) {
               var rateLimitError = {
                 message: 'Rate limited',
                 data: {
-                  code: _errorTypes.NCS_ERROR_CODE.RATE_LIMIT_ERROR,
+                  code: _ncsErrors.NCS_ERROR_CODE.RATE_LIMIT_ERROR,
                   status: 500,
                   meta: {
                     rateLimitType: rateLimitType,

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

@@ -20,8 +20,9 @@ var _editorJsonTransformer = require("@atlaskit/editor-json-transformer");
 var _provider = require("../provider");
 var _catchup = require("./catchup");
 var _stepQueueState = require("./step-queue-state");
+var _internalErrors = require("../errors/internal-errors");
 var _featureFlags = require("../feature-flags");
-var _errorTypes = require("../errors/error-types");
+var _customErrors = require("../errors/custom-errors");
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 var CATCHUP_THROTTLE = 1 * 1000; // 1 second
@@ -234,7 +235,7 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
           data: {
             status: 500,
             // Meaningless, remove when we review error structure
-            code: _errorTypes.INTERNAL_ERROR_CODE.ADD_STEPS_ERROR
+            code: _internalErrors.INTERNAL_ERROR_CODE.ADD_STEPS_ERROR
           }
         });
       }
@@ -281,7 +282,7 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
           data: {
             status: 500,
             // Meaningless, remove when we review error structure
-            code: _errorTypes.INTERNAL_ERROR_CODE.DOCUMENT_RESTORE_ERROR
+            code: _internalErrors.INTERNAL_ERROR_CODE.DOCUMENT_RESTORE_ERROR
           }
         });
       }
@@ -362,7 +363,7 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
       var isDocContentValid = _this.validatePMJSONDocument(doc);
       if (_this.getCurrentPmVersion() !== version) {
         var _doc$content, _this$analyticsHelper17;
-        var _error = new _errorTypes.UpdateDocumentError('Failed to update the document', {
+        var _error = new _customErrors.UpdateDocumentError('Failed to update the document', {
           newVersion: version,
           editorVersion: updatedVersion,
           isDocTruthy: !!doc,
@@ -374,7 +375,7 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
           _this.onErrorHandled({
             message: 'The provider failed to apply changes to the editor',
             data: {
-              code: _errorTypes.INTERNAL_ERROR_CODE.DOCUMENT_UPDATE_ERROR,
+              code: _internalErrors.INTERNAL_ERROR_CODE.DOCUMENT_UPDATE_ERROR,
               meta: {
                 newVersion: version,
                 editorVersion: updatedVersion
@@ -480,7 +481,7 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
             unconfirmedStepsInfoUGCRemoved = (_this$getUnconfirmedS = _this.getUnconfirmedSteps()) === null || _this$getUnconfirmedS === void 0 ? void 0 : _this$getUnconfirmedS.map(function (step) {
               return (0, _utils.getStepUGCFreeDetails)(step);
             });
-            _error2 = new _errorTypes.CantSyncUpError("Can't sync up with Collab Service: unable to send unconfirmed steps and max retry reached", {
+            _error2 = new _customErrors.CantSyncUpError("Can't sync up with Collab Service: unable to send unconfirmed steps and max retry reached", {
               unconfirmedStepsInfo: unconfirmedStepsInfoUGCRemoved ? unconfirmedStepsInfoUGCRemoved.toString() : 'Unable to generate UGC removed step info'
             });
             throw _error2;

package/dist/cjs/errors/{error-types.js → custom-errors.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.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.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"));
@@ -15,73 +15,6 @@ var _wrapNativeSuper2 = _interopRequireDefault(require("@babel/runtime/helpers/w
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = (0, _getPrototypeOf2.default)(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = (0, _getPrototypeOf2.default)(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return (0, _possibleConstructorReturn2.default)(this, result); }; }
 function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
-// Internal error codes (generated by collab provider)
-var INTERNAL_ERROR_CODE = exports.INTERNAL_ERROR_CODE = /*#__PURE__*/function (INTERNAL_ERROR_CODE) {
-  INTERNAL_ERROR_CODE["TOKEN_PERMISSION_ERROR"] = "TOKEN_PERMISSION_ERROR";
-  INTERNAL_ERROR_CODE["RECONNECTION_NETWORK_ISSUE"] = "RECONNECTION_NETWORK_ISSUE";
-  INTERNAL_ERROR_CODE["CONNECTION_ERROR"] = "CONNECTION_ERROR";
-  INTERNAL_ERROR_CODE["RECONNECTION_ERROR"] = "RECONNECTION_ERROR";
-  INTERNAL_ERROR_CODE["DOCUMENT_NOT_FOUND"] = "DOCUMENT_NOT_FOUND";
-  INTERNAL_ERROR_CODE["CATCHUP_FAILED"] = "CATCHUP_FAILED";
-  INTERNAL_ERROR_CODE["DOCUMENT_RESTORE_ERROR"] = "DOCUMENT_RESTORE_ERROR";
-  INTERNAL_ERROR_CODE["ADD_STEPS_ERROR"] = "ADD_STEPS_ERROR";
-  INTERNAL_ERROR_CODE["DOCUMENT_UPDATE_ERROR"] = "DOCUMENT_UPDATE_ERROR";
-  return INTERNAL_ERROR_CODE;
-}({}); // NCS error coded (generated by NCS)
-var NCS_ERROR_CODE = exports.NCS_ERROR_CODE = /*#__PURE__*/function (NCS_ERROR_CODE) {
-  NCS_ERROR_CODE["HEAD_VERSION_UPDATE_FAILED"] = "HEAD_VERSION_UPDATE_FAILED";
-  NCS_ERROR_CODE["VERSION_NUMBER_ALREADY_EXISTS"] = "VERSION_NUMBER_ALREADY_EXISTS";
-  NCS_ERROR_CODE["INSUFFICIENT_EDITING_PERMISSION"] = "INSUFFICIENT_EDITING_PERMISSION";
-  NCS_ERROR_CODE["FORBIDDEN_USER_TOKEN"] = "FORBIDDEN_USER_TOKEN";
-  NCS_ERROR_CODE["DOCUMENT_NOT_FOUND"] = "DOCUMENT_NOT_FOUND";
-  NCS_ERROR_CODE["INIT_DATA_LOAD_FAILED"] = "INIT_DATA_LOAD_FAILED";
-  NCS_ERROR_CODE["ERROR_MAPPING_ERROR"] = "ERROR_MAPPING_ERROR";
-  NCS_ERROR_CODE["NAMESPACE_INVALID"] = "NAMESPACE_INVALID";
-  NCS_ERROR_CODE["NAMESPACE_NOT_FOUND"] = "NAMESPACE_NOT_FOUND";
-  NCS_ERROR_CODE["TENANT_INSTANCE_MAINTENANCE"] = "TENANT_INSTANCE_MAINTENANCE";
-  NCS_ERROR_CODE["LOCKED_DOCUMENT"] = "LOCKED_DOCUMENT";
-  NCS_ERROR_CODE["EMPTY_BROADCAST"] = "EMPTY_BROADCAST";
-  NCS_ERROR_CODE["DYNAMO_ERROR"] = "DYNAMO_ERROR";
-  NCS_ERROR_CODE["INVALID_ACTIVATION_ID"] = "INVALID_ACTIVATION_ID";
-  NCS_ERROR_CODE["INVALID_DOCUMENT_ARI"] = "INVALID_DOCUMENT_ARI";
-  NCS_ERROR_CODE["INVALID_CLOUD_ID"] = "INVALID_CLOUD_ID";
-  NCS_ERROR_CODE["RATE_LIMIT_ERROR"] = "RATE_LIMIT_ERROR";
-  return NCS_ERROR_CODE;
-}({}); // TODO: Import emitted error codes from NCS
-// NCS Errors
-// - Step rejection errors
-// - Permission errors
-// - Page missing / TTL errors
-// - Server errors
-// - Less common back-end errors
-// Provider Errors
-// Channel Errors
-/**
- * When we try to apply state updates to the editor, if that fails to apply the user can enter an invalid state where no
- * changes can be saved to NCS.
- */
-/**
- * The client is trying to send too many messages or messages that are too large. This not expected to be a standard
- * operating condition and should only ever indicate a frontend bug.
- */
-/**
- * A union of all possible internal errors, that are mapped to another error if being emitted to the editor.
- */
-/*
- * This is what a generic ProviderError type would look like:
- * type ProviderError = {
- *   // Unique code, identifies the specific emitted error
- *   // Also exposed as a PROVIDER_ERROR_CODE enum to allow subscribers to use them
- *   code: PROVIDER_ERROR_CODE;
- *   // Informative message describing what went wrong
- *   message: string;
- *   // Flag indicating whether an error is recoverable or not
- *   // used by consumers to disable the provider and show an error message
- *   recoverable: boolean;
- *   // A reason code used to give more detail about why a certain error was thrown
- *   reason?: string;
- * }
- */
 // Custom Errors
 var CustomError = exports.CustomError = /*#__PURE__*/function (_Error) {
   (0, _inherits2.default)(CustomError, _Error);

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

@@ -4,7 +4,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.errorCodeMapper = void 0;
-var _errorTypes = require("./error-types");
+var _ncsErrors = require("./ncs-errors");
+var _internalErrors = require("./internal-errors");
 var _collab = require("@atlaskit/editor-common/collab");
 /*
  * Maps internal collab provider errors to an emitted error format
@@ -12,17 +13,17 @@ var _collab = require("@atlaskit/editor-common/collab");
 var errorCodeMapper = exports.errorCodeMapper = function errorCodeMapper(error) {
   var _error$data, _error$data2, _error$data3, _error$data4;
   switch ((_error$data = error.data) === null || _error$data === void 0 ? void 0 : _error$data.code) {
-    case _errorTypes.NCS_ERROR_CODE.HEAD_VERSION_UPDATE_FAILED:
-    case _errorTypes.NCS_ERROR_CODE.VERSION_NUMBER_ALREADY_EXISTS:
+    case _ncsErrors.NCS_ERROR_CODE.HEAD_VERSION_UPDATE_FAILED:
+    case _ncsErrors.NCS_ERROR_CODE.VERSION_NUMBER_ALREADY_EXISTS:
       // This should never be called with these errors
       return;
-    case _errorTypes.INTERNAL_ERROR_CODE.ADD_STEPS_ERROR:
-    case _errorTypes.INTERNAL_ERROR_CODE.RECONNECTION_ERROR:
-    case _errorTypes.INTERNAL_ERROR_CODE.CONNECTION_ERROR:
+    case _internalErrors.INTERNAL_ERROR_CODE.ADD_STEPS_ERROR:
+    case _internalErrors.INTERNAL_ERROR_CODE.RECONNECTION_ERROR:
+    case _internalErrors.INTERNAL_ERROR_CODE.CONNECTION_ERROR:
       // These errors shouldn't be emitted, we're hoping the provider self-recovers over time
       return;
-    case _errorTypes.NCS_ERROR_CODE.INSUFFICIENT_EDITING_PERMISSION:
-    case _errorTypes.INTERNAL_ERROR_CODE.TOKEN_PERMISSION_ERROR:
+    case _ncsErrors.NCS_ERROR_CODE.INSUFFICIENT_EDITING_PERMISSION:
+    case _internalErrors.INTERNAL_ERROR_CODE.TOKEN_PERMISSION_ERROR:
       return {
         code: _collab.PROVIDER_ERROR_CODE.NO_PERMISSION_ERROR,
         message: 'User does not have permissions to access this document or document is not found',
@@ -30,66 +31,66 @@ var errorCodeMapper = exports.errorCodeMapper = function errorCodeMapper(error)
         recoverable: true,
         status: 403
       };
-    case _errorTypes.NCS_ERROR_CODE.FORBIDDEN_USER_TOKEN:
+    case _ncsErrors.NCS_ERROR_CODE.FORBIDDEN_USER_TOKEN:
       return {
         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:
+    case _internalErrors.INTERNAL_ERROR_CODE.DOCUMENT_NOT_FOUND:
       return {
         code: _collab.PROVIDER_ERROR_CODE.DOCUMENT_NOT_FOUND,
         message: 'The requested document is not found',
         recoverable: true,
         status: 404
       };
-    case _errorTypes.NCS_ERROR_CODE.TENANT_INSTANCE_MAINTENANCE:
-    case _errorTypes.NCS_ERROR_CODE.LOCKED_DOCUMENT:
+    case _ncsErrors.NCS_ERROR_CODE.TENANT_INSTANCE_MAINTENANCE:
+    case _ncsErrors.NCS_ERROR_CODE.LOCKED_DOCUMENT:
       return {
         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:
+    case _ncsErrors.NCS_ERROR_CODE.DYNAMO_ERROR:
       return {
         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:
+    case _internalErrors.INTERNAL_ERROR_CODE.DOCUMENT_RESTORE_ERROR:
       return {
         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:
+    case _ncsErrors.NCS_ERROR_CODE.INIT_DATA_LOAD_FAILED:
       return {
         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:
+    case _internalErrors.INTERNAL_ERROR_CODE.DOCUMENT_UPDATE_ERROR:
       return {
         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:
+    case _internalErrors.INTERNAL_ERROR_CODE.RECONNECTION_NETWORK_ISSUE:
       return {
         code: _collab.PROVIDER_ERROR_CODE.NETWORK_ISSUE,
         message: "Couldn't reconnect to the collab service due to network issues",
         recoverable: true,
         status: 500
       };
-    case _errorTypes.NCS_ERROR_CODE.NAMESPACE_INVALID:
-    case _errorTypes.NCS_ERROR_CODE.INVALID_ACTIVATION_ID:
-    case _errorTypes.NCS_ERROR_CODE.INVALID_DOCUMENT_ARI:
-    case _errorTypes.NCS_ERROR_CODE.INVALID_CLOUD_ID:
+    case _ncsErrors.NCS_ERROR_CODE.NAMESPACE_INVALID:
+    case _ncsErrors.NCS_ERROR_CODE.INVALID_ACTIVATION_ID:
+    case _ncsErrors.NCS_ERROR_CODE.INVALID_DOCUMENT_ARI:
+    case _ncsErrors.NCS_ERROR_CODE.INVALID_CLOUD_ID:
       return {
         code: _collab.PROVIDER_ERROR_CODE.INVALID_PROVIDER_CONFIGURATION,
         message: 'Invalid provider configuration',
@@ -97,9 +98,9 @@ var errorCodeMapper = exports.errorCodeMapper = function errorCodeMapper(error)
         reason: (_error$data2 = error.data) === null || _error$data2 === void 0 ? void 0 : _error$data2.code,
         status: 400
       };
-    case _errorTypes.NCS_ERROR_CODE.NAMESPACE_NOT_FOUND:
-    case _errorTypes.NCS_ERROR_CODE.ERROR_MAPPING_ERROR:
-    case _errorTypes.NCS_ERROR_CODE.EMPTY_BROADCAST:
+    case _ncsErrors.NCS_ERROR_CODE.NAMESPACE_NOT_FOUND:
+    case _ncsErrors.NCS_ERROR_CODE.ERROR_MAPPING_ERROR:
+    case _ncsErrors.NCS_ERROR_CODE.EMPTY_BROADCAST:
       return {
         code: _collab.PROVIDER_ERROR_CODE.INTERNAL_SERVICE_ERROR,
         message: 'Collab Provider experienced an unrecoverable error',
@@ -107,7 +108,7 @@ var errorCodeMapper = exports.errorCodeMapper = function errorCodeMapper(error)
         reason: (_error$data3 = error.data) === null || _error$data3 === void 0 ? void 0 : _error$data3.code,
         status: 500
       };
-    case _errorTypes.INTERNAL_ERROR_CODE.CATCHUP_FAILED:
+    case _internalErrors.INTERNAL_ERROR_CODE.CATCHUP_FAILED:
       return {
         code: _collab.PROVIDER_ERROR_CODE.INTERNAL_SERVICE_ERROR,
         message: 'Collab Provider experienced an unrecoverable error',
@@ -115,7 +116,7 @@ var errorCodeMapper = exports.errorCodeMapper = function errorCodeMapper(error)
         reason: (_error$data4 = error.data) === null || _error$data4 === void 0 ? void 0 : _error$data4.code,
         status: 500
       };
-    case _errorTypes.NCS_ERROR_CODE.RATE_LIMIT_ERROR:
+    case _ncsErrors.NCS_ERROR_CODE.RATE_LIMIT_ERROR:
       return {
         code: _collab.PROVIDER_ERROR_CODE.FAIL_TO_SAVE,
         message: 'Document rate limit',

package/dist/cjs/errors/internal-errors.js

@@ -0,0 +1,40 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.INTERNAL_ERROR_CODE = void 0;
+var INTERNAL_ERROR_CODE = exports.INTERNAL_ERROR_CODE = /*#__PURE__*/function (INTERNAL_ERROR_CODE) {
+  INTERNAL_ERROR_CODE["TOKEN_PERMISSION_ERROR"] = "TOKEN_PERMISSION_ERROR";
+  INTERNAL_ERROR_CODE["RECONNECTION_NETWORK_ISSUE"] = "RECONNECTION_NETWORK_ISSUE";
+  INTERNAL_ERROR_CODE["CONNECTION_ERROR"] = "CONNECTION_ERROR";
+  INTERNAL_ERROR_CODE["RECONNECTION_ERROR"] = "RECONNECTION_ERROR";
+  INTERNAL_ERROR_CODE["DOCUMENT_NOT_FOUND"] = "DOCUMENT_NOT_FOUND";
+  INTERNAL_ERROR_CODE["CATCHUP_FAILED"] = "CATCHUP_FAILED";
+  INTERNAL_ERROR_CODE["DOCUMENT_RESTORE_ERROR"] = "DOCUMENT_RESTORE_ERROR";
+  INTERNAL_ERROR_CODE["ADD_STEPS_ERROR"] = "ADD_STEPS_ERROR";
+  INTERNAL_ERROR_CODE["DOCUMENT_UPDATE_ERROR"] = "DOCUMENT_UPDATE_ERROR";
+  return INTERNAL_ERROR_CODE;
+}({}); // Channel Errors
+/**
+ * When we try to apply state updates to the editor, if that fails to apply the user can enter an invalid state where no
+ * changes can be saved to NCS.
+ */
+/**
+ * A union of all possible internal errors, that are mapped to another error if being emitted to the editor.
+ */
+/*
+ * This is what a generic ProviderError type would look like:
+ * type ProviderError = {
+ *   // Unique code, identifies the specific emitted error
+ *   // Also exposed as a PROVIDER_ERROR_CODE enum to allow subscribers to use them
+ *   code: PROVIDER_ERROR_CODE;
+ *   // Informative message describing what went wrong
+ *   message: string;
+ *   // Flag indicating whether an error is recoverable or not
+ *   // used by consumers to disable the provider and show an error message
+ *   recoverable: boolean;
+ *   // A reason code used to give more detail about why a certain error was thrown
+ *   reason?: string;
+ * }
+ */

package/dist/cjs/errors/ncs-errors.js

@@ -0,0 +1,37 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.NCS_ERROR_CODE = void 0;
+// NCS error coded (generated by NCS)
+var NCS_ERROR_CODE = exports.NCS_ERROR_CODE = /*#__PURE__*/function (NCS_ERROR_CODE) {
+  NCS_ERROR_CODE["HEAD_VERSION_UPDATE_FAILED"] = "HEAD_VERSION_UPDATE_FAILED";
+  NCS_ERROR_CODE["VERSION_NUMBER_ALREADY_EXISTS"] = "VERSION_NUMBER_ALREADY_EXISTS";
+  NCS_ERROR_CODE["INSUFFICIENT_EDITING_PERMISSION"] = "INSUFFICIENT_EDITING_PERMISSION";
+  NCS_ERROR_CODE["FORBIDDEN_USER_TOKEN"] = "FORBIDDEN_USER_TOKEN";
+  NCS_ERROR_CODE["DOCUMENT_NOT_FOUND"] = "DOCUMENT_NOT_FOUND";
+  NCS_ERROR_CODE["INIT_DATA_LOAD_FAILED"] = "INIT_DATA_LOAD_FAILED";
+  NCS_ERROR_CODE["ERROR_MAPPING_ERROR"] = "ERROR_MAPPING_ERROR";
+  NCS_ERROR_CODE["NAMESPACE_INVALID"] = "NAMESPACE_INVALID";
+  NCS_ERROR_CODE["NAMESPACE_NOT_FOUND"] = "NAMESPACE_NOT_FOUND";
+  NCS_ERROR_CODE["TENANT_INSTANCE_MAINTENANCE"] = "TENANT_INSTANCE_MAINTENANCE";
+  NCS_ERROR_CODE["LOCKED_DOCUMENT"] = "LOCKED_DOCUMENT";
+  NCS_ERROR_CODE["EMPTY_BROADCAST"] = "EMPTY_BROADCAST";
+  NCS_ERROR_CODE["DYNAMO_ERROR"] = "DYNAMO_ERROR";
+  NCS_ERROR_CODE["INVALID_ACTIVATION_ID"] = "INVALID_ACTIVATION_ID";
+  NCS_ERROR_CODE["INVALID_DOCUMENT_ARI"] = "INVALID_DOCUMENT_ARI";
+  NCS_ERROR_CODE["INVALID_CLOUD_ID"] = "INVALID_CLOUD_ID";
+  NCS_ERROR_CODE["RATE_LIMIT_ERROR"] = "RATE_LIMIT_ERROR";
+  return NCS_ERROR_CODE;
+}({}); // TODO: Import emitted error codes from NCS
+// NCS Errors
+// - Step rejection errors
+// - Permission errors
+// - Page missing / TTL errors
+// - Server errors
+// - Less common back-end errors
+/**
+ * The client is trying to send too many messages or messages that are too large. This not expected to be a standard
+ * operating condition and should only ever indicate a frontend bug.
+ */

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

@@ -10,7 +10,7 @@ var _countBy = _interopRequireDefault(require("lodash/countBy"));
 var _throttle = _interopRequireDefault(require("lodash/throttle"));
 var _const = require("../helpers/const");
 var _types = require("../types");
-var _errorTypes = require("../errors/error-types");
+var _ncsErrors = require("../errors/ncs-errors");
 var _utils = require("../helpers/utils");
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
@@ -92,7 +92,7 @@ var commitStepQueue = exports.commitStepQueue = function commitStepQueue(_ref) {
           // User tried committing steps but they were rejected because:
           // - HEAD_VERSION_UPDATE_FAILED: the collab service's latest stored step tail version didn't correspond to the head version of the first step submitted
           // - VERSION_NUMBER_ALREADY_EXISTS: while storing the steps there was a conflict meaning someone else wrote steps into the database more quickly
-          type: response.error.data.code === _errorTypes.NCS_ERROR_CODE.HEAD_VERSION_UPDATE_FAILED || response.error.data.code === _errorTypes.NCS_ERROR_CODE.VERSION_NUMBER_ALREADY_EXISTS ? _const.ADD_STEPS_TYPE.REJECTED : _const.ADD_STEPS_TYPE.ERROR,
+          type: response.error.data.code === _ncsErrors.NCS_ERROR_CODE.HEAD_VERSION_UPDATE_FAILED || response.error.data.code === _ncsErrors.NCS_ERROR_CODE.VERSION_NUMBER_ALREADY_EXISTS ? _const.ADD_STEPS_TYPE.REJECTED : _const.ADD_STEPS_TYPE.ERROR,
           latency: latency
         });
         analyticsHelper === null || analyticsHelper === void 0 || analyticsHelper.sendErrorEvent(response.error, 'Error while adding steps - Acknowledgement Error');
@@ -171,7 +171,7 @@ var commitStep = exports.commitStep = function commitStep(_ref2) {
           // User tried committing steps but they were rejected because:
           // - HEAD_VERSION_UPDATE_FAILED: the collab service's latest stored step tail version didn't correspond to the head version of the first step submitted
           // - VERSION_NUMBER_ALREADY_EXISTS: while storing the steps there was a conflict meaning someone else wrote steps into the database more quickly
-          type: response.error.data.code === _errorTypes.NCS_ERROR_CODE.HEAD_VERSION_UPDATE_FAILED || response.error.data.code === _errorTypes.NCS_ERROR_CODE.VERSION_NUMBER_ALREADY_EXISTS ? _const.ADD_STEPS_TYPE.REJECTED : _const.ADD_STEPS_TYPE.ERROR,
+          type: response.error.data.code === _ncsErrors.NCS_ERROR_CODE.HEAD_VERSION_UPDATE_FAILED || response.error.data.code === _ncsErrors.NCS_ERROR_CODE.VERSION_NUMBER_ALREADY_EXISTS ? _const.ADD_STEPS_TYPE.REJECTED : _const.ADD_STEPS_TYPE.ERROR,
           latency: latency
         });
         analyticsHelper === null || analyticsHelper === void 0 || analyticsHelper.sendErrorEvent(response.error, 'Error while adding steps - Acknowledgement Error');