@atlaskit/media-client 29.1.0 → 31.0.0

package/CHANGELOG.md

@@ -1,5 +1,44 @@
 # @atlaskit/media-client
 
+## 31.0.0
+
+### Major Changes
+
+- [#104917](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/104917)
+  [`f5b9e90ce5043`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/f5b9e90ce5043) -
+  changed useFileHashes to take an array of identifiers which it will then pre-emptively fetch
+  metadata when it detects duplicates with missing hashes
+
+### Minor Changes
+
+- [#104917](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/104917)
+  [`4c1c65faff476`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/4c1c65faff476) -
+  Adding forceRefresh to fileState request to enable removing cache and forcing the refetching of
+  meta-data
+
+## 30.0.0
+
+### Major Changes
+
+- [#102527](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/102527)
+  [`a90d34cd14faf`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/a90d34cd14faf) -
+  Updated the constructor of the following classes. Consult the type definitions for details.
+
+  - `RequestError`
+
+  - `PollingError`
+
+  - `FileFetcherError`
+
+### Minor Changes
+
+- [#102527](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/102527)
+  [`a90d34cd14faf`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/a90d34cd14faf) - -
+  New error verification helper `isCommonMediaClientError`
+
+  - `ErrorFileState` is now deserializable into a `CommonMediaClientError` using new export
+    `toCommonMediaClientError`
+
 ## 29.1.0
 
 ### Minor Changes

package/dist/cjs/client/file-fetcher/error.js

@@ -18,26 +18,28 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
 function _callSuper(t, o, e) { return o = (0, _getPrototypeOf2.default)(o), (0, _possibleConstructorReturn2.default)(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], (0, _getPrototypeOf2.default)(t).constructor) : o.apply(t, e)); }
 function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
 var FileFetcherError = exports.FileFetcherError = /*#__PURE__*/function (_BaseMediaClientError) {
-  function FileFetcherError(reason, id, metadata) {
+  // Legacy Attribute. Should be removed
+
+  function FileFetcherError(reason, metadata) {
     var _this;
     (0, _classCallCheck2.default)(this, FileFetcherError);
-    _this = _callSuper(this, FileFetcherError, [reason]);
-    _this.reason = reason;
-    _this.id = id;
-    _this.metadata = metadata;
+    _this = _callSuper(this, FileFetcherError, [reason, metadata, undefined]);
+    _this.id = metadata.id;
     return _this;
   }
+
+  // TODO: Deprecate this getter https://product-fabric.atlassian.net/browse/CXP-4665
+  /** Will be deprecated. Use the properties `reason` and `metadata` instead */
   (0, _inherits2.default)(FileFetcherError, _BaseMediaClientError);
   return (0, _createClass2.default)(FileFetcherError, [{
     key: "attributes",
     get: function get() {
       var reason = this.reason,
-        id = this.id,
         _this$metadata = this.metadata,
-        _this$metadata2 = _this$metadata === void 0 ? {} : _this$metadata,
-        collectionName = _this$metadata2.collectionName,
-        occurrenceKey = _this$metadata2.occurrenceKey,
-        traceContext = _this$metadata2.traceContext;
+        id = _this$metadata.id,
+        collectionName = _this$metadata.collectionName,
+        occurrenceKey = _this$metadata.occurrenceKey,
+        traceContext = _this$metadata.traceContext;
       return _objectSpread({
         reason: reason,
         id: id,

package/dist/cjs/client/file-fetcher/index.js

@@ -19,7 +19,6 @@ Object.defineProperty(exports, "isFileFetcherError", {
 });
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
-var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
@@ -51,8 +50,7 @@ var _detectEmptyFile = require("../../utils/detectEmptyFile");
 var _mediaState = require("@atlaskit/media-state");
 var _createCopyIntentRegisterationBatcher = require("../../utils/createCopyIntentRegisterationBatcher");
 var _helpers = require("../../utils/request/helpers");
-var _excluded = ["metadata"],
-  _excluded2 = ["metadata"];
+var _errors = require("../../models/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 isCopySourceFileWithToken = function isCopySourceFileWithToken(token) {
@@ -67,26 +65,20 @@ var FileFetcherImpl = exports.FileFetcherImpl = /*#__PURE__*/function () {
     var store = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : _mediaState.mediaStore;
     (0, _classCallCheck2.default)(this, FileFetcherImpl);
     (0, _defineProperty2.default)(this, "getErrorFileState", function (error, id, occurrenceKey) {
-      var _error$attributes;
-      var _ref = (_error$attributes = error === null || error === void 0 ? void 0 : error.attributes) !== null && _error$attributes !== void 0 ? _error$attributes : {},
-        metadata = _ref.metadata,
-        attributes = (0, _objectWithoutProperties2.default)(_ref, _excluded);
-      return typeof error === 'string' ? {
-        status: 'error',
-        id: id,
-        reason: error,
-        occurrenceKey: occurrenceKey,
-        message: error
-      } : {
-        status: 'error',
-        id: id,
-        reason: error === null || error === void 0 ? void 0 : error.reason,
-        details: _objectSpread(_objectSpread({}, attributes), (metadata === null || metadata === void 0 ? void 0 : metadata.traceContext) && {
-          metadata: metadata
-        }),
-        occurrenceKey: occurrenceKey,
-        message: error === null || error === void 0 ? void 0 : error.message
-      };
+      if ((0, _errors.isCommonMediaClientError)(error)) {
+        return (0, _errors.fromCommonMediaClientError)(id, occurrenceKey, error);
+      }
+      // ________________________________________________
+      // Legacy serializers
+      // We need to revisit all the incoming error types and ensure all the "reason" values are known
+      // We need to change the input error: any for a known type.
+      if (typeof error === 'string') {
+        var err = new _errors.CommonMediaClientError(error);
+        return (0, _errors.fromCommonMediaClientError)(id, occurrenceKey, err);
+      } else {
+        var _err = new _errors.CommonMediaClientError((error === null || error === void 0 ? void 0 : error.reason) || 'unknown', error === null || error === void 0 ? void 0 : error.metadata, error === null || error === void 0 ? void 0 : error.innerError);
+        return (0, _errors.fromCommonMediaClientError)(id, occurrenceKey, _err);
+      }
     });
     (0, _defineProperty2.default)(this, "setFileState", function (id, fileState) {
       _this.store.setState(function (state) {
@@ -94,7 +86,7 @@ var FileFetcherImpl = exports.FileFetcherImpl = /*#__PURE__*/function () {
       });
     });
     // TODO: ----- ADD TICKET TO PASS TRACE ID to this.dataloader.load
-    (0, _defineProperty2.default)(this, "createDownloadFileStream", function (id, collectionName, occurrenceKey, includeHashForDuplicateFiles) {
+    (0, _defineProperty2.default)(this, "createDownloadFileStream", function (id, collectionName, occurrenceKey, includeHashForDuplicateFiles, forceRefresh) {
       var subject = (0, _createMediaSubject.createMediaSubject)();
       var poll = new _polling.PollingFunction();
 
@@ -107,47 +99,56 @@ var FileFetcherImpl = exports.FileFetcherImpl = /*#__PURE__*/function () {
         return _regenerator.default.wrap(function _callee$(_context) {
           while (1) switch (_context.prev = _context.next) {
             case 0:
-              _context.next = 2;
+              if (forceRefresh) {
+                _this.dataloader.clear({
+                  id: id,
+                  collectionName: collectionName,
+                  includeHashForDuplicateFiles: includeHashForDuplicateFiles
+                });
+              }
+              _context.next = 3;
               return _this.dataloader.load({
                 id: id,
                 collectionName: collectionName,
                 includeHashForDuplicateFiles: includeHashForDuplicateFiles
               });
-            case 2:
+            case 3:
               response = _context.sent;
               if (!(0, _media.isNotFoundMediaItemDetails)(response)) {
-                _context.next = 5;
+                _context.next = 6;
                 break;
               }
-              throw new _error.FileFetcherError('emptyItems', id, {
+              throw new _error.FileFetcherError('emptyItems', {
+                id: id,
                 collectionName: collectionName,
                 occurrenceKey: occurrenceKey,
                 traceContext: response.metadataTraceContext
               });
-            case 5:
+            case 6:
               if (!(0, _detectEmptyFile.isEmptyFile)(response)) {
-                _context.next = 7;
+                _context.next = 8;
                 break;
               }
-              throw new _error.FileFetcherError('zeroVersionFile', id, {
+              throw new _error.FileFetcherError('zeroVersionFile', {
+                id: id,
                 collectionName: collectionName,
                 occurrenceKey: occurrenceKey,
                 traceContext: response.metadataTraceContext
               });
-            case 7:
+            case 8:
               fileState = (0, _fileState2.mapMediaItemToFileState)(id, response);
               subject.next(fileState);
               _context.t0 = fileState.status;
-              _context.next = _context.t0 === 'processing' ? 12 : _context.t0 === 'processed' ? 14 : 16;
+              _context.next = _context.t0 === 'processing' ? 13 : _context.t0 === 'processed' ? 15 : 17;
               break;
-            case 12:
+            case 13:
               // the only case for continuing polling, otherwise this function is run once only
               poll.next();
-              return _context.abrupt("break", 16);
-            case 14:
+              return _context.abrupt("break", 17);
+            case 15:
               subject.complete();
-              return _context.abrupt("break", 16);
-            case 16:
+              return _context.abrupt("break", 17);
+            case 17:
             case "end":
               return _context.stop();
           }
@@ -200,33 +201,25 @@ var FileFetcherImpl = exports.FileFetcherImpl = /*#__PURE__*/function () {
       var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
       var collectionName = options.collectionName,
         occurrenceKey = options.occurrenceKey,
-        includeHashForDuplicateFiles = options.includeHashForDuplicateFiles;
+        includeHashForDuplicateFiles = options.includeHashForDuplicateFiles,
+        forceRefresh = options.forceRefresh;
       if (!(0, _uuidValidate.default)(id)) {
-        var _err$attributes;
         var subject = (0, _createMediaSubject.createMediaSubject)();
-        var err = new _error.FileFetcherError('invalidFileId', id, {
+        var err = new _error.FileFetcherError('invalidFileId', {
+          id: id,
           collectionName: collectionName,
           occurrenceKey: occurrenceKey
         });
-        var _ref3 = (_err$attributes = err === null || err === void 0 ? void 0 : err.attributes) !== null && _err$attributes !== void 0 ? _err$attributes : {},
-          metadata = _ref3.metadata,
-          attributes = (0, _objectWithoutProperties2.default)(_ref3, _excluded2);
-        var errorFileState = {
-          status: 'error',
-          id: id,
-          reason: err === null || err === void 0 ? void 0 : err.reason,
-          message: err === null || err === void 0 ? void 0 : err.message,
-          occurrenceKey: occurrenceKey,
-          details: _objectSpread(_objectSpread({}, attributes), (metadata === null || metadata === void 0 ? void 0 : metadata.traceContext) && {
-            metadata: metadata
-          })
-        };
+        var errorFileState = this.getErrorFileState(err, id, occurrenceKey);
         subject.error(err);
         this.setFileState(id, errorFileState);
         return (0, _mediaSubscribable.fromObservable)(subject);
       }
+      if (forceRefresh) {
+        (0, _fileStreamsCache.getFileStreamsCache)().remove(id);
+      }
       return (0, _mediaSubscribable.fromObservable)((0, _fileStreamsCache.getFileStreamsCache)().getOrInsert(id, function () {
-        var subject = _this2.createDownloadFileStream(id, collectionName, undefined, includeHashForDuplicateFiles);
+        var subject = _this2.createDownloadFileStream(id, collectionName, undefined, includeHashForDuplicateFiles, forceRefresh);
         subject.subscribe({
           next: function next(fileState) {
             _this2.setFileState(id, fileState);
@@ -261,8 +254,8 @@ var FileFetcherImpl = exports.FileFetcherImpl = /*#__PURE__*/function () {
         descriptors: descriptors
       }, {
         collection: collection
-      }, traceContext).then(function (_ref4) {
-        var data = _ref4.data;
+      }, traceContext).then(function (_ref2) {
+        var data = _ref2.data;
         return data;
       });
     }
@@ -303,7 +296,7 @@ var FileFetcherImpl = exports.FileFetcherImpl = /*#__PURE__*/function () {
                 return undefined;
               });
               preview = new Promise( /*#__PURE__*/function () {
-                var _ref5 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(resolve, reject) {
+                var _ref3 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(resolve, reject) {
                   var blob;
                   return _regenerator.default.wrap(function _callee2$(_context2) {
                     while (1) switch (_context2.prev = _context2.next) {
@@ -326,7 +319,7 @@ var FileFetcherImpl = exports.FileFetcherImpl = /*#__PURE__*/function () {
                   }, _callee2);
                 }));
                 return function (_x4, _x5) {
-                  return _ref5.apply(this, arguments);
+                  return _ref3.apply(this, arguments);
                 };
               }());
               name = url.split('/').pop() || ''; // we create a initial fileState with the minimum info that we have at this point
@@ -345,7 +338,7 @@ var FileFetcherImpl = exports.FileFetcherImpl = /*#__PURE__*/function () {
               (0, _fileStreamsCache.getFileStreamsCache)().set(id, subject);
               this.setFileState(id, fileState);
               return _context4.abrupt("return", new Promise( /*#__PURE__*/function () {
-                var _ref6 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3(resolve, reject) {
+                var _ref4 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3(resolve, reject) {
                   var blob, type, size, file, mediaType, dimensions;
                   return _regenerator.default.wrap(function _callee3$(_context3) {
                     while (1) switch (_context3.prev = _context3.next) {
@@ -406,7 +399,7 @@ var FileFetcherImpl = exports.FileFetcherImpl = /*#__PURE__*/function () {
                   }, _callee3, null, [[10, 16]]);
                 }));
                 return function (_x6, _x7) {
-                  return _ref6.apply(this, arguments);
+                  return _ref4.apply(this, arguments);
                 };
               }()));
             case 11:

package/dist/cjs/client/media-store/error.js

@@ -16,13 +16,12 @@ function _callSuper(t, o, e) { return o = (0, _getPrototypeOf2.default)(o), (0,
 function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
 var MediaStoreError = exports.MediaStoreError = /*#__PURE__*/function (_BaseMediaClientError) {
   function MediaStoreError(reason, innerError) {
-    var _this;
     (0, _classCallCheck2.default)(this, MediaStoreError);
-    _this = _callSuper(this, MediaStoreError, [reason]);
-    _this.reason = reason;
-    _this.innerError = innerError;
-    return _this;
+    return _callSuper(this, MediaStoreError, [reason, undefined, innerError]);
   }
+
+  // TODO: Deprecate this getter https://product-fabric.atlassian.net/browse/CXP-4665
+  /** Will be deprecated. Use the properties `reason` and `metadata` instead */
   (0, _inherits2.default)(MediaStoreError, _BaseMediaClientError);
   return (0, _createClass2.default)(MediaStoreError, [{
     key: "attributes",

package/dist/cjs/index.js

@@ -183,6 +183,12 @@ Object.defineProperty(exports, "isAbortedRequestError", {
     return _helpers.isAbortedRequestError;
   }
 });
+Object.defineProperty(exports, "isCommonMediaClientError", {
+  enumerable: true,
+  get: function get() {
+    return _errors.isCommonMediaClientError;
+  }
+});
 Object.defineProperty(exports, "isDifferentIdentifier", {
   enumerable: true,
   get: function get() {
@@ -243,6 +249,12 @@ Object.defineProperty(exports, "isMediaStoreError", {
     return _mediaStore.isMediaStoreError;
   }
 });
+Object.defineProperty(exports, "isNonErrorFinalFileState", {
+  enumerable: true,
+  get: function get() {
+    return _fileState.isNonErrorFinalFileState;
+  }
+});
 Object.defineProperty(exports, "isPollingError", {
   enumerable: true,
   get: function get() {
@@ -315,6 +327,12 @@ Object.defineProperty(exports, "request", {
     return _request.request;
   }
 });
+Object.defineProperty(exports, "toCommonMediaClientError", {
+  enumerable: true,
+  get: function get() {
+    return _errors.toCommonMediaClientError;
+  }
+});
 Object.defineProperty(exports, "uploadFile", {
   enumerable: true,
   get: function get() {

package/dist/cjs/models/errors/index.js

@@ -4,19 +4,22 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.BaseMediaClientError = void 0;
+exports.fromCommonMediaClientError = exports.CommonMediaClientError = exports.BaseMediaClientError = void 0;
 Object.defineProperty(exports, "getMediaClientErrorReason", {
   enumerable: true,
   get: function get() {
     return _helpers.getMediaClientErrorReason;
   }
 });
+exports.isCommonMediaClientError = isCommonMediaClientError;
 Object.defineProperty(exports, "isMediaClientError", {
   enumerable: true,
   get: function get() {
     return _helpers.isMediaClientError;
   }
 });
+exports.toCommonMediaClientError = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 var _possibleConstructorReturn2 = _interopRequireDefault(require("@babel/runtime/helpers/possibleConstructorReturn"));
@@ -24,19 +27,23 @@ var _getPrototypeOf2 = _interopRequireDefault(require("@babel/runtime/helpers/ge
 var _inherits2 = _interopRequireDefault(require("@babel/runtime/helpers/inherits"));
 var _wrapNativeSuper2 = _interopRequireDefault(require("@babel/runtime/helpers/wrapNativeSuper"));
 var _helpers = require("./helpers");
+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; }
 function _callSuper(t, o, e) { return o = (0, _getPrototypeOf2.default)(o), (0, _possibleConstructorReturn2.default)(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], (0, _getPrototypeOf2.default)(t).constructor) : o.apply(t, e)); }
 function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
 /**
  * Base class for media errors
  */
 var BaseMediaClientError = exports.BaseMediaClientError = /*#__PURE__*/function (_Error) {
-  function BaseMediaClientError(message) {
+  function BaseMediaClientError(reason, metadata, innerError) {
     var _this;
     (0, _classCallCheck2.default)(this, BaseMediaClientError);
-    _this = _callSuper(this, BaseMediaClientError, [message]);
+    _this = _callSuper(this, BaseMediaClientError, [reason]);
 
     // https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-2.html#support-for-newtarget
-    _this.message = message;
+    _this.reason = reason;
+    _this.metadata = metadata;
+    _this.innerError = innerError;
     Object.setPrototypeOf(_this, (this instanceof BaseMediaClientError ? this.constructor : void 0).prototype);
 
     // https://v8.dev/docs/stack-trace-api
@@ -45,6 +52,62 @@ var BaseMediaClientError = exports.BaseMediaClientError = /*#__PURE__*/function
     }
     return _this;
   }
+
+  // TODO: Deprecate attributes getter https://product-fabric.atlassian.net/browse/CXP-4665
   (0, _inherits2.default)(BaseMediaClientError, _Error);
   return (0, _createClass2.default)(BaseMediaClientError);
-}( /*#__PURE__*/(0, _wrapNativeSuper2.default)(Error));
+}( /*#__PURE__*/(0, _wrapNativeSuper2.default)(Error
+// TODO: Deprecate attributes getter https://product-fabric.atlassian.net/browse/CXP-4665
+)); // The only reason why this class exists is because BaseMediaClientError is abstract class, so it can't be used to deserialize ErrorFileState. We can refactor and simplify this later.
+/** Generic Media Client Erorr. All errors extending BaseMediaClientError match CommonMediaClientError attributes. Used to deserialize ErrorFileState */
+var CommonMediaClientError = exports.CommonMediaClientError = /*#__PURE__*/function (_BaseMediaClientError) {
+  function CommonMediaClientError(reason, metadata, innerError) {
+    (0, _classCallCheck2.default)(this, CommonMediaClientError);
+    return _callSuper(this, CommonMediaClientError, [reason, metadata, innerError]);
+  }
+  (0, _inherits2.default)(CommonMediaClientError, _BaseMediaClientError);
+  return (0, _createClass2.default)(CommonMediaClientError, [{
+    key: "attributes",
+    get: function get() {
+      return {
+        reason: this.reason
+      };
+    }
+  }]);
+}(BaseMediaClientError);
+function isCommonMediaClientError(error) {
+  if (!error) {
+    return false;
+  }
+  // Check if the error is an instance of Error
+  if (error instanceof CommonMediaClientError) {
+    return true;
+  }
+  return typeof error.reason === 'string' && ('metadata' in error || error.metadata === undefined) && ('innerError' in error || error.innerError === undefined);
+}
+
+/** Deserializer ErrorFileState -> CommonMediaClientError */
+var toCommonMediaClientError = exports.toCommonMediaClientError = function toCommonMediaClientError(errorFileState) {
+  var _errorFileState$detai;
+  var error = (_errorFileState$detai = errorFileState.details) === null || _errorFileState$detai === void 0 ? void 0 : _errorFileState$detai.error;
+  return new CommonMediaClientError((error === null || error === void 0 ? void 0 : error.reason) || 'unknown-reason', error.metadata, error.innerError);
+};
+
+/** Serializer CommonMediaClientError -> ErrorFileState */
+var fromCommonMediaClientError = exports.fromCommonMediaClientError = function fromCommonMediaClientError(id, occurrenceKey, error) {
+  return {
+    status: 'error',
+    id: id,
+    occurrenceKey: occurrenceKey,
+    reason: error.reason,
+    details: _objectSpread({
+      /** Use this attr to translate back into CommonMediaClientError (toCommonMediaClientError) */
+      error: {
+        reason: error === null || error === void 0 ? void 0 : error.reason,
+        metadata: error === null || error === void 0 ? void 0 : error.metadata,
+        innerError: error === null || error === void 0 ? void 0 : error.innerError
+      }
+    }, error === null || error === void 0 ? void 0 : error.attributes),
+    message: error === null || error === void 0 ? void 0 : error.message
+  };
+};

package/dist/cjs/models/errors/types.js

@@ -1 +1,5 @@
-"use strict";
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/dist/cjs/models/file-state.js

@@ -4,7 +4,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.mapMediaItemToFileState = exports.mapMediaFileToFileState = exports.isUploadingFileState = exports.isProcessingFileState = exports.isProcessedFileState = exports.isPreviewableFileState = exports.isImageRepresentationReady = exports.isFinalFileState = exports.isErrorFileState = void 0;
+exports.mapMediaItemToFileState = exports.mapMediaFileToFileState = exports.isUploadingFileState = exports.isProcessingFileState = exports.isProcessedFileState = exports.isPreviewableFileState = exports.isNonErrorFinalFileState = exports.isImageRepresentationReady = exports.isFinalFileState = exports.isErrorFileState = void 0;
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 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; }
@@ -26,6 +26,9 @@ var isPreviewableFileState = exports.isPreviewableFileState = function isPreview
 var isFinalFileState = exports.isFinalFileState = function isFinalFileState(fileState) {
   return ['processed', 'failed-processing', 'error'].includes(fileState.status);
 };
+var isNonErrorFinalFileState = exports.isNonErrorFinalFileState = function isNonErrorFinalFileState(fileState) {
+  return ['processed', 'failed-processing'].includes(fileState.status);
+};
 var isImageRepresentationReady = exports.isImageRepresentationReady = function isImageRepresentationReady(fileState) {
   switch (fileState.status) {
     case 'processing':

package/dist/cjs/uploader/error.js

@@ -15,25 +15,27 @@ var _errors = require("../models/errors");
 function _callSuper(t, o, e) { return o = (0, _getPrototypeOf2.default)(o), (0, _possibleConstructorReturn2.default)(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], (0, _getPrototypeOf2.default)(t).constructor) : o.apply(t, e)); }
 function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
 var UploaderError = exports.UploaderError = /*#__PURE__*/function (_BaseMediaClientError) {
-  function UploaderError(reason, id, metadata) {
+  // Legacy Attribute. Should be removed
+
+  function UploaderError(reason, metadata) {
     var _this;
     (0, _classCallCheck2.default)(this, UploaderError);
-    _this = _callSuper(this, UploaderError, [reason]);
-    _this.reason = reason;
-    _this.id = id;
-    _this.metadata = metadata;
+    _this = _callSuper(this, UploaderError, [reason, metadata, undefined]);
+    _this.id = metadata.id;
     return _this;
   }
+
+  // TODO: Deprecate this getter https://product-fabric.atlassian.net/browse/CXP-4665
+  /** Will be deprecated. Use the properties `reason` and `metadata` instead */
   (0, _inherits2.default)(UploaderError, _BaseMediaClientError);
   return (0, _createClass2.default)(UploaderError, [{
     key: "attributes",
     get: function get() {
       var reason = this.reason,
-        id = this.id,
         _this$metadata = this.metadata,
-        _this$metadata2 = _this$metadata === void 0 ? {} : _this$metadata,
-        collectionName = _this$metadata2.collectionName,
-        occurrenceKey = _this$metadata2.occurrenceKey;
+        id = _this$metadata.id,
+        collectionName = _this$metadata.collectionName,
+        occurrenceKey = _this$metadata.occurrenceKey;
       return {
         reason: reason,
         id: id,

package/dist/cjs/uploader/index.js

@@ -149,7 +149,8 @@ var uploadFile = exports.uploadFile = function uploadFile(file, store, uploadabl
     }
   } catch (err) {
     if (err instanceof Error && err.message === _calculateChunkSize.fileSizeError) {
-      callbacks === null || callbacks === void 0 || callbacks.onUploadFinish(new _error.UploaderError(err.message, id, {
+      callbacks === null || callbacks === void 0 || callbacks.onUploadFinish(new _error.UploaderError(err.message, {
+        id: id,
         collectionName: collection,
         occurrenceKey: occurrenceKey
       }));

package/dist/cjs/utils/mobileUpload/error.js

@@ -15,26 +15,28 @@ var _errors = require("../../models/errors");
 function _callSuper(t, o, e) { return o = (0, _getPrototypeOf2.default)(o), (0, _possibleConstructorReturn2.default)(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], (0, _getPrototypeOf2.default)(t).constructor) : o.apply(t, e)); }
 function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
 var MobileUploadError = exports.MobileUploadError = /*#__PURE__*/function (_BaseMediaClientError) {
-  function MobileUploadError(reason, id, metadata) {
+  // Legacy Attribute. Should be removed
+
+  function MobileUploadError(reason, metadata) {
     var _this;
     (0, _classCallCheck2.default)(this, MobileUploadError);
-    _this = _callSuper(this, MobileUploadError, [reason]);
-    _this.reason = reason;
-    _this.id = id;
-    _this.metadata = metadata;
+    _this = _callSuper(this, MobileUploadError, [reason, metadata, undefined]);
+    _this.id = metadata.id;
     return _this;
   }
+
+  // TODO: Deprecate this getter https://product-fabric.atlassian.net/browse/CXP-4665
+  /** Will be deprecated. Use the properties `reason` and `metadata` instead */
   (0, _inherits2.default)(MobileUploadError, _BaseMediaClientError);
   return (0, _createClass2.default)(MobileUploadError, [{
     key: "attributes",
     get: function get() {
       var reason = this.reason,
-        id = this.id,
         _this$metadata = this.metadata,
-        _this$metadata2 = _this$metadata === void 0 ? {} : _this$metadata,
-        collectionName = _this$metadata2.collectionName,
-        occurrenceKey = _this$metadata2.occurrenceKey,
-        traceContext = _this$metadata2.traceContext;
+        id = _this$metadata.id,
+        collectionName = _this$metadata.collectionName,
+        occurrenceKey = _this$metadata.occurrenceKey,
+        traceContext = _this$metadata.traceContext;
       return {
         reason: reason,
         id: id,

package/dist/cjs/utils/mobileUpload/helpers.js

@@ -47,7 +47,8 @@ var createMobileDownloadFileStream = exports.createMobileDownloadFileStream = fu
             _context.next = 5;
             break;
           }
-          throw new _error.MobileUploadError('emptyItems', id, {
+          throw new _error.MobileUploadError('emptyItems', {
+            id: id,
             collectionName: collectionName,
             occurrenceKey: occurrenceKey,
             traceContext: response.metadataTraceContext
@@ -57,7 +58,8 @@ var createMobileDownloadFileStream = exports.createMobileDownloadFileStream = fu
             _context.next = 7;
             break;
           }
-          throw new _error.MobileUploadError('zeroVersionFile', id, {
+          throw new _error.MobileUploadError('zeroVersionFile', {
+            id: id,
             collectionName: collectionName,
             occurrenceKey: occurrenceKey,
             traceContext: response.metadataTraceContext