@atlaskit/media-client 29.1.0 → 30.0.0

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

@@ -1,9 +1,12 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import _createClass from "@babel/runtime/helpers/createClass";
 import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
 import _possibleConstructorReturn from "@babel/runtime/helpers/possibleConstructorReturn";
 import _getPrototypeOf from "@babel/runtime/helpers/getPrototypeOf";
 import _inherits from "@babel/runtime/helpers/inherits";
 import _wrapNativeSuper from "@babel/runtime/helpers/wrapNativeSuper";
+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) { _defineProperty(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 = _getPrototypeOf(o), _possibleConstructorReturn(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], _getPrototypeOf(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; })(); }
 export { isMediaClientError, getMediaClientErrorReason } from './helpers';
@@ -12,13 +15,15 @@ export { isMediaClientError, getMediaClientErrorReason } from './helpers';
  * Base class for media errors
  */
 export var BaseMediaClientError = /*#__PURE__*/function (_Error) {
-  function BaseMediaClientError(message) {
+  function BaseMediaClientError(reason, metadata, innerError) {
     var _this;
     _classCallCheck(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
@@ -27,6 +32,64 @@ export var BaseMediaClientError = /*#__PURE__*/function (_Error) {
     }
     return _this;
   }
+
+  // TODO: Deprecate attributes getter https://product-fabric.atlassian.net/browse/CXP-4665
   _inherits(BaseMediaClientError, _Error);
   return _createClass(BaseMediaClientError);
-}( /*#__PURE__*/_wrapNativeSuper(Error));
+}( /*#__PURE__*/_wrapNativeSuper(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 */
+export var CommonMediaClientError = /*#__PURE__*/function (_BaseMediaClientError) {
+  function CommonMediaClientError(reason, metadata, innerError) {
+    _classCallCheck(this, CommonMediaClientError);
+    return _callSuper(this, CommonMediaClientError, [reason, metadata, innerError]);
+  }
+  _inherits(CommonMediaClientError, _BaseMediaClientError);
+  return _createClass(CommonMediaClientError, [{
+    key: "attributes",
+    get: function get() {
+      return {
+        reason: this.reason
+      };
+    }
+  }]);
+}(BaseMediaClientError);
+export 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 */
+export var 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 */
+export var 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/esm/models/errors/types.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/uploader/error.js

@@ -7,25 +7,27 @@ function _callSuper(t, o, e) { return o = _getPrototypeOf(o), _possibleConstruct
 function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
 import { BaseMediaClientError } from '../models/errors';
 export var UploaderError = /*#__PURE__*/function (_BaseMediaClientError) {
-  function UploaderError(reason, id, metadata) {
+  // Legacy Attribute. Should be removed
+
+  function UploaderError(reason, metadata) {
     var _this;
     _classCallCheck(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 */
   _inherits(UploaderError, _BaseMediaClientError);
   return _createClass(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/esm/uploader/index.js

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

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

@@ -7,26 +7,28 @@ function _callSuper(t, o, e) { return o = _getPrototypeOf(o), _possibleConstruct
 function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
 import { BaseMediaClientError } from '../../models/errors';
 export var MobileUploadError = /*#__PURE__*/function (_BaseMediaClientError) {
-  function MobileUploadError(reason, id, metadata) {
+  // Legacy Attribute. Should be removed
+
+  function MobileUploadError(reason, metadata) {
     var _this;
     _classCallCheck(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 */
   _inherits(MobileUploadError, _BaseMediaClientError);
   return _createClass(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/esm/utils/mobileUpload/helpers.js

@@ -40,7 +40,8 @@ export var createMobileDownloadFileStream = function createMobileDownloadFileStr
             _context.next = 5;
             break;
           }
-          throw new MobileUploadError('emptyItems', id, {
+          throw new MobileUploadError('emptyItems', {
+            id: id,
             collectionName: collectionName,
             occurrenceKey: occurrenceKey,
             traceContext: response.metadataTraceContext
@@ -50,7 +51,8 @@ export var createMobileDownloadFileStream = function createMobileDownloadFileStr
             _context.next = 7;
             break;
           }
-          throw new MobileUploadError('zeroVersionFile', id, {
+          throw new MobileUploadError('zeroVersionFile', {
+            id: id,
             collectionName: collectionName,
             occurrenceKey: occurrenceKey,
             traceContext: response.metadataTraceContext

package/dist/esm/utils/polling/errors.js

@@ -7,20 +7,19 @@ function _callSuper(t, o, e) { return o = _getPrototypeOf(o), _possibleConstruct
 function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
 import { BaseMediaClientError } from '../../models/errors';
 export var PollingError = /*#__PURE__*/function (_BaseMediaClientError) {
-  function PollingError(reason, attempts) {
-    var _this;
+  function PollingError(reason, metadata) {
     _classCallCheck(this, PollingError);
-    _this = _callSuper(this, PollingError, [reason]);
-    _this.reason = reason;
-    _this.attempts = attempts;
-    return _this;
+    return _callSuper(this, PollingError, [reason, metadata, undefined]);
   }
+
+  // TODO: Deprecate this getter https://product-fabric.atlassian.net/browse/CXP-4665
+  /** Will be deprecated. Use the properties `reason` and `metadata` instead */
   _inherits(PollingError, _BaseMediaClientError);
   return _createClass(PollingError, [{
     key: "attributes",
     get: function get() {
       var reason = this.reason,
-        attempts = this.attempts;
+        attempts = this.metadata.attempts;
       return {
         reason: reason,
         attempts: attempts

package/dist/esm/utils/polling/index.js

@@ -50,7 +50,9 @@ export var PollingFunction = /*#__PURE__*/function () {
                 _context.next = 3;
                 break;
               }
-              return _context.abrupt("return", this.fail(new PollingError('pollingMaxAttemptsExceeded', this.attempt)));
+              return _context.abrupt("return", this.fail(new PollingError('pollingMaxAttemptsExceeded', {
+                attempts: this.attempt
+              })));
             case 3:
               _context.prev = 3;
               // executor must explicitly call this.next() for triggering next iteration (pull)
@@ -68,7 +70,9 @@ export var PollingFunction = /*#__PURE__*/function () {
                 _context.next = 11;
                 break;
               }
-              return _context.abrupt("return", this.fail(new PollingError('pollingMaxAttemptsExceeded', this.attempt)));
+              return _context.abrupt("return", this.fail(new PollingError('pollingMaxAttemptsExceeded', {
+                attempts: this.attempt
+              })));
             case 11:
               this.poll_intervalMs = this.getIntervalMsForIteration(this.attempt);
               this.attempt++;

package/dist/esm/utils/request/errors.js

@@ -8,14 +8,12 @@ function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.
 import { BaseMediaClientError } from '../../models/errors';
 export var RequestError = /*#__PURE__*/function (_BaseMediaClientError) {
   function RequestError(reason, metadata, innerError) {
-    var _this;
     _classCallCheck(this, RequestError);
-    _this = _callSuper(this, RequestError, [reason]);
-    _this.reason = reason;
-    _this.metadata = metadata;
-    _this.innerError = innerError;
-    return _this;
+    return _callSuper(this, RequestError, [reason, metadata, innerError]);
   }
+
+  // TODO: Deprecate this getter https://product-fabric.atlassian.net/browse/CXP-4665
+  /** Will be deprecated. Use the properties `reason` and `metadata` instead */
   _inherits(RequestError, _BaseMediaClientError);
   return _createClass(RequestError, [{
     key: "attributes",

package/dist/esm/utils/request/helpers.js

@@ -9,6 +9,10 @@ import { isClientBasedAuth } from '@atlaskit/media-core';
 import { getRandomHex } from '@atlaskit/media-common';
 import { mapAuthToQueryParameters } from '../../models/auth-query-parameters';
 import { RequestError, isRequestError } from './errors';
+var getStatusCode = function getStatusCode(error) {
+  var _error$metadata;
+  return isRequestError(error) && ((_error$metadata = error.metadata) === null || _error$metadata === void 0 ? void 0 : _error$metadata.statusCode) && error.metadata.statusCode;
+};
 export function waitPromise(timeout) {
   return new Promise(function (resolve) {
     return setTimeout(resolve, timeout);
@@ -23,7 +27,8 @@ export function isFetchNetworkError(err) {
   return err instanceof TypeError;
 }
 export function isRateLimitedError(error) {
-  return !!error && isRequestError(error) && error.attributes.statusCode === 429 || !!error && !!error.message && error.message.includes('429');
+  var statusCode = error && getStatusCode(error);
+  return statusCode === 429 || !!error && !!error.message && error.message.includes('429');
 }
 export var extendTraceContext = function extendTraceContext(traceContext) {
   return traceContext ? _objectSpread(_objectSpread({}, traceContext), {}, {
@@ -136,8 +141,8 @@ export function createMapResponseToBlob(metadata) {
   }();
 }
 export var defaultShouldRetryError = function defaultShouldRetryError(err) {
-  var _err$metadata;
-  return isFetchNetworkError(err) || isRequestError(err) && !!(err !== null && err !== void 0 && (_err$metadata = err.metadata) !== null && _err$metadata !== void 0 && _err$metadata.statusCode) && err.metadata.statusCode >= 500;
+  var statusCode = getStatusCode(err);
+  return isFetchNetworkError(err) || (statusCode ? statusCode >= 500 : false);
 };
 export var DEFAULT_RETRY_OPTIONS = {
   startTimeoutInMs: 1000,

package/dist/types/client/file-fetcher/error.d.ts

@@ -10,19 +10,16 @@ export type FileFetcherErrorAttributes = {
         readonly traceContext?: MediaTraceContext;
     };
 };
-export declare class FileFetcherError extends BaseMediaClientError<FileFetcherErrorAttributes> {
-    readonly reason: FileFetcherErrorReason;
+export type FileFetcherErrorMetadata = {
     readonly id: string;
-    readonly metadata?: {
-        readonly collectionName?: string | undefined;
-        readonly occurrenceKey?: string | undefined;
-        readonly traceContext?: MediaTraceContext | undefined;
-    } | undefined;
-    constructor(reason: FileFetcherErrorReason, id: string, metadata?: {
-        readonly collectionName?: string | undefined;
-        readonly occurrenceKey?: string | undefined;
-        readonly traceContext?: MediaTraceContext | undefined;
-    } | undefined);
+    readonly collectionName?: string;
+    readonly occurrenceKey?: string;
+    readonly traceContext?: MediaTraceContext;
+};
+export declare class FileFetcherError extends BaseMediaClientError<FileFetcherErrorReason, FileFetcherErrorMetadata, undefined, FileFetcherErrorAttributes> {
+    readonly id: string;
+    constructor(reason: FileFetcherErrorReason, metadata: FileFetcherErrorMetadata);
+    /** Will be deprecated. Use the properties `reason` and `metadata` instead */
     get attributes(): {
         metadata?: {
             traceContext: MediaTraceContext;

package/dist/types/client/media-store/error.d.ts

@@ -4,10 +4,9 @@ export type MediaStoreErrorAttributes = {
     readonly reason: MediaStoreErrorReason;
     readonly innerError?: Error;
 };
-export declare class MediaStoreError extends BaseMediaClientError<MediaStoreErrorAttributes> {
-    readonly reason: MediaStoreErrorReason;
-    readonly innerError?: Error | undefined;
-    constructor(reason: MediaStoreErrorReason, innerError?: Error | undefined);
+export declare class MediaStoreError extends BaseMediaClientError<MediaStoreErrorReason, undefined, Error | undefined, MediaStoreErrorAttributes> {
+    constructor(reason: MediaStoreErrorReason, innerError?: Error);
+    /** Will be deprecated. Use the properties `reason` and `metadata` instead */
     get attributes(): {
         reason: MediaStoreErrorReason;
         innerError: Error | undefined;

package/dist/types/index.d.ts

@@ -6,7 +6,7 @@ export type { MediaItemType, FileItem, FileProcessingStatus, MediaArtifact, Arti
 export { isPreviewableType } from './models/media';
 export type { MediaFileProcessingStatus, MediaType, MediaFile, MediaRepresentations, MediaItemDetails, MediaUpload, } from './models/media';
 export { getArtifactUrl } from './models/artifacts';
-export { isMediaClientError, getMediaClientErrorReason } from './models/errors';
+export { isMediaClientError, getMediaClientErrorReason, isCommonMediaClientError, toCommonMediaClientError, } from './models/errors';
 export type { MediaClientError, MediaClientErrorReason, MediaClientErrorAttributes, } from './models/errors';
 export { isUploadingFileState, isProcessingFileState, isProcessedFileState, isErrorFileState, isPreviewableFileState, isFinalFileState, isImageRepresentationReady, mapMediaFileToFileState, mapMediaItemToFileState, } from './models/file-state';
 export type { FileStatus, PreviewOptions, GetFileOptions, NonErrorFileState, PreviewableFileState, } from './models/file-state';

package/dist/types/models/errors/index.d.ts

@@ -1,11 +1,24 @@
-import { type MediaClientError, type MediaClientErrorAttributes } from './types';
+import type { ErrorFileState } from '@atlaskit/media-state';
+import type { MediaClientError, MediaClientErrorAttributes, MediaClientErrorReason, MediaClientErrorMetadata } from './types';
 export type { MediaClientError, MediaClientErrorReason, MediaClientErrorAttributes } from './types';
 export { isMediaClientError, getMediaClientErrorReason } from './helpers';
 /**
  * Base class for media errors
  */
-export declare abstract class BaseMediaClientError<Attributes extends MediaClientErrorAttributes> extends Error implements MediaClientError<Attributes> {
-    readonly message: string;
-    constructor(message: string);
+export declare abstract class BaseMediaClientError<Reason extends MediaClientErrorReason, Metadata extends MediaClientErrorMetadata | undefined, InnerError extends Error | undefined, Attributes extends MediaClientErrorAttributes> extends Error implements MediaClientError<Attributes> {
+    readonly reason: Reason;
+    readonly metadata: Metadata;
+    readonly innerError: InnerError;
+    constructor(reason: Reason, metadata: Metadata, innerError: InnerError);
     abstract get attributes(): Attributes;
 }
+/** Generic Media Client Erorr. All errors extending BaseMediaClientError match CommonMediaClientError attributes. Used to deserialize ErrorFileState */
+export declare class CommonMediaClientError extends BaseMediaClientError<MediaClientErrorReason, MediaClientErrorMetadata | undefined, Error | undefined, MediaClientErrorAttributes> {
+    constructor(reason: MediaClientErrorReason, metadata?: MediaClientErrorMetadata, innerError?: Error);
+    get attributes(): MediaClientErrorAttributes;
+}
+export declare function isCommonMediaClientError(error: any): error is BaseMediaClientError<MediaClientErrorReason, MediaClientErrorMetadata | undefined, Error | undefined, MediaClientErrorAttributes>;
+/** Deserializer ErrorFileState -> CommonMediaClientError */
+export declare const toCommonMediaClientError: (errorFileState: ErrorFileState) => CommonMediaClientError;
+/** Serializer CommonMediaClientError -> ErrorFileState */
+export declare const fromCommonMediaClientError: (id: string, occurrenceKey: string | undefined, error: CommonMediaClientError) => ErrorFileState;

package/dist/types/models/errors/types.d.ts

@@ -1,4 +1,11 @@
+import { type MediaTraceContext } from '@atlaskit/media-common';
+export interface SerializableObject {
+    [key: string]: string | number | boolean | null | undefined | SerializableObject;
+}
 export type MediaClientErrorReason = 'clientOffline' | 'clientAbortedRequest' | 'clientTimeoutRequest' | 'serverInvalidBody' | 'serverBadRequest' | 'serverUnauthorized' | 'serverForbidden' | 'serverNotFound' | 'serverRateLimited' | 'serverInternalError' | 'serverBadGateway' | 'serverUnexpectedError' | 'failedAuthProvider' | 'tokenExpired' | 'missingInitialAuth' | 'emptyAuth' | 'authProviderTimedOut' | 'invalidFileId' | 'emptyItems' | 'zeroVersionFile' | 'emptyFileName' | 'pollingMaxAttemptsExceeded' | 'fileSizeExceedsLimit' | 'deprecatedEndpoint';
+export type MediaClientErrorMetadata = SerializableObject & {
+    traceContext?: MediaTraceContext;
+};
 export interface MediaClientErrorAttributes {
     reason: MediaClientErrorReason;
 }

package/dist/types/uploader/error.d.ts

@@ -8,17 +8,15 @@ export type UploaderErrorAttributes = {
         readonly occurrenceKey?: string;
     };
 };
-export declare class UploaderError extends BaseMediaClientError<UploaderErrorAttributes> {
-    readonly reason: UploaderErrorReason;
+export type UploaderErrorMetadata = {
     readonly id: string;
-    readonly metadata?: {
-        readonly collectionName?: string | undefined;
-        readonly occurrenceKey?: string | undefined;
-    } | undefined;
-    constructor(reason: UploaderErrorReason, id: string, metadata?: {
-        readonly collectionName?: string | undefined;
-        readonly occurrenceKey?: string | undefined;
-    } | undefined);
+    readonly collectionName?: string;
+    readonly occurrenceKey?: string;
+};
+export declare class UploaderError extends BaseMediaClientError<UploaderErrorReason, UploaderErrorMetadata, undefined, UploaderErrorAttributes> {
+    readonly id: string;
+    constructor(reason: UploaderErrorReason, metadata: UploaderErrorMetadata);
+    /** Will be deprecated. Use the properties `reason` and `metadata` instead */
     get attributes(): {
         reason: "fileSizeExceedsLimit";
         id: string;

package/dist/types/utils/mobileUpload/error.d.ts

@@ -10,19 +10,16 @@ export type MobileUploadErrorAttributes = {
         readonly traceContext?: MediaTraceContext;
     };
 };
-export declare class MobileUploadError extends BaseMediaClientError<MobileUploadErrorAttributes> {
-    readonly reason: MobileUploadErrorReason;
+export type MobileUploadErrorMetadata = {
     readonly id: string;
-    readonly metadata?: {
-        readonly collectionName?: string | undefined;
-        readonly occurrenceKey?: string | undefined;
-        readonly traceContext?: MediaTraceContext | undefined;
-    } | undefined;
-    constructor(reason: MobileUploadErrorReason, id: string, metadata?: {
-        readonly collectionName?: string | undefined;
-        readonly occurrenceKey?: string | undefined;
-        readonly traceContext?: MediaTraceContext | undefined;
-    } | undefined);
+    readonly collectionName?: string;
+    readonly occurrenceKey?: string;
+    readonly traceContext?: MediaTraceContext;
+};
+export declare class MobileUploadError extends BaseMediaClientError<MobileUploadErrorReason, MobileUploadErrorMetadata, undefined, MobileUploadErrorAttributes> {
+    readonly id: string;
+    constructor(reason: MobileUploadErrorReason, metadata: MobileUploadErrorMetadata);
+    /** Will be deprecated. Use the properties `reason` and `metadata` instead */
     get attributes(): {
         reason: MobileUploadErrorReason;
         id: string;

package/dist/types/utils/polling/errors.d.ts

@@ -1,9 +1,8 @@
 import { BaseMediaClientError } from '../../models/errors';
-import { type PollingErrorReason, type PollingErrorAttributes } from './types';
-export declare class PollingError extends BaseMediaClientError<PollingErrorAttributes> {
-    readonly reason: PollingErrorReason;
-    readonly attempts: number;
-    constructor(reason: PollingErrorReason, attempts: number);
+import { type PollingErrorReason, type PollingErrorAttributes, type PollingErrorMetadata } from './types';
+export declare class PollingError extends BaseMediaClientError<PollingErrorReason, PollingErrorMetadata, undefined, PollingErrorAttributes> {
+    constructor(reason: PollingErrorReason, metadata: PollingErrorMetadata);
+    /** Will be deprecated. Use the properties `reason` and `metadata` instead */
     get attributes(): {
         reason: "pollingMaxAttemptsExceeded";
         attempts: number;

package/dist/types/utils/polling/types.d.ts

@@ -1,5 +1,8 @@
 export type Executor = () => Promise<void>;
 export type PollingErrorReason = 'pollingMaxAttemptsExceeded';
+export type PollingErrorMetadata = {
+    attempts: number;
+};
 export type PollingErrorAttributes = {
     readonly reason: PollingErrorReason;
     readonly attempts: number;

package/dist/types/utils/request/errors.d.ts

@@ -1,10 +1,8 @@
 import { BaseMediaClientError } from '../../models/errors';
 import { type RequestErrorReason, type RequestErrorMetadata, type RequestErrorAttributes } from './types';
-export declare class RequestError extends BaseMediaClientError<RequestErrorAttributes> {
-    readonly reason: RequestErrorReason;
-    readonly metadata?: RequestErrorMetadata | undefined;
-    readonly innerError?: Error | undefined;
-    constructor(reason: RequestErrorReason, metadata?: RequestErrorMetadata | undefined, innerError?: Error | undefined);
+export declare class RequestError extends BaseMediaClientError<RequestErrorReason, RequestErrorMetadata | undefined, Error | undefined, RequestErrorAttributes> {
+    constructor(reason: RequestErrorReason, metadata?: RequestErrorMetadata, innerError?: Error);
+    /** Will be deprecated. Use the properties `reason` and `metadata` instead */
     get attributes(): {
         reason: RequestErrorReason;
         method: import("./types").RequestMethod | undefined;

package/dist/types-ts4.5/client/file-fetcher/error.d.ts

@@ -10,19 +10,16 @@ export type FileFetcherErrorAttributes = {
         readonly traceContext?: MediaTraceContext;
     };
 };
-export declare class FileFetcherError extends BaseMediaClientError<FileFetcherErrorAttributes> {
-    readonly reason: FileFetcherErrorReason;
+export type FileFetcherErrorMetadata = {
     readonly id: string;
-    readonly metadata?: {
-        readonly collectionName?: string | undefined;
-        readonly occurrenceKey?: string | undefined;
-        readonly traceContext?: MediaTraceContext | undefined;
-    } | undefined;
-    constructor(reason: FileFetcherErrorReason, id: string, metadata?: {
-        readonly collectionName?: string | undefined;
-        readonly occurrenceKey?: string | undefined;
-        readonly traceContext?: MediaTraceContext | undefined;
-    } | undefined);
+    readonly collectionName?: string;
+    readonly occurrenceKey?: string;
+    readonly traceContext?: MediaTraceContext;
+};
+export declare class FileFetcherError extends BaseMediaClientError<FileFetcherErrorReason, FileFetcherErrorMetadata, undefined, FileFetcherErrorAttributes> {
+    readonly id: string;
+    constructor(reason: FileFetcherErrorReason, metadata: FileFetcherErrorMetadata);
+    /** Will be deprecated. Use the properties `reason` and `metadata` instead */
     get attributes(): {
         metadata?: {
             traceContext: MediaTraceContext;

package/dist/types-ts4.5/client/media-store/error.d.ts

@@ -4,10 +4,9 @@ export type MediaStoreErrorAttributes = {
     readonly reason: MediaStoreErrorReason;
     readonly innerError?: Error;
 };
-export declare class MediaStoreError extends BaseMediaClientError<MediaStoreErrorAttributes> {
-    readonly reason: MediaStoreErrorReason;
-    readonly innerError?: Error | undefined;
-    constructor(reason: MediaStoreErrorReason, innerError?: Error | undefined);
+export declare class MediaStoreError extends BaseMediaClientError<MediaStoreErrorReason, undefined, Error | undefined, MediaStoreErrorAttributes> {
+    constructor(reason: MediaStoreErrorReason, innerError?: Error);
+    /** Will be deprecated. Use the properties `reason` and `metadata` instead */
     get attributes(): {
         reason: MediaStoreErrorReason;
         innerError: Error | undefined;

package/dist/types-ts4.5/index.d.ts

@@ -6,7 +6,7 @@ export type { MediaItemType, FileItem, FileProcessingStatus, MediaArtifact, Arti
 export { isPreviewableType } from './models/media';
 export type { MediaFileProcessingStatus, MediaType, MediaFile, MediaRepresentations, MediaItemDetails, MediaUpload, } from './models/media';
 export { getArtifactUrl } from './models/artifacts';
-export { isMediaClientError, getMediaClientErrorReason } from './models/errors';
+export { isMediaClientError, getMediaClientErrorReason, isCommonMediaClientError, toCommonMediaClientError, } from './models/errors';
 export type { MediaClientError, MediaClientErrorReason, MediaClientErrorAttributes, } from './models/errors';
 export { isUploadingFileState, isProcessingFileState, isProcessedFileState, isErrorFileState, isPreviewableFileState, isFinalFileState, isImageRepresentationReady, mapMediaFileToFileState, mapMediaItemToFileState, } from './models/file-state';
 export type { FileStatus, PreviewOptions, GetFileOptions, NonErrorFileState, PreviewableFileState, } from './models/file-state';

package/dist/types-ts4.5/models/errors/index.d.ts

@@ -1,11 +1,24 @@
-import { type MediaClientError, type MediaClientErrorAttributes } from './types';
+import type { ErrorFileState } from '@atlaskit/media-state';
+import type { MediaClientError, MediaClientErrorAttributes, MediaClientErrorReason, MediaClientErrorMetadata } from './types';
 export type { MediaClientError, MediaClientErrorReason, MediaClientErrorAttributes } from './types';
 export { isMediaClientError, getMediaClientErrorReason } from './helpers';
 /**
  * Base class for media errors
  */
-export declare abstract class BaseMediaClientError<Attributes extends MediaClientErrorAttributes> extends Error implements MediaClientError<Attributes> {
-    readonly message: string;
-    constructor(message: string);
+export declare abstract class BaseMediaClientError<Reason extends MediaClientErrorReason, Metadata extends MediaClientErrorMetadata | undefined, InnerError extends Error | undefined, Attributes extends MediaClientErrorAttributes> extends Error implements MediaClientError<Attributes> {
+    readonly reason: Reason;
+    readonly metadata: Metadata;
+    readonly innerError: InnerError;
+    constructor(reason: Reason, metadata: Metadata, innerError: InnerError);
     abstract get attributes(): Attributes;
 }
+/** Generic Media Client Erorr. All errors extending BaseMediaClientError match CommonMediaClientError attributes. Used to deserialize ErrorFileState */
+export declare class CommonMediaClientError extends BaseMediaClientError<MediaClientErrorReason, MediaClientErrorMetadata | undefined, Error | undefined, MediaClientErrorAttributes> {
+    constructor(reason: MediaClientErrorReason, metadata?: MediaClientErrorMetadata, innerError?: Error);
+    get attributes(): MediaClientErrorAttributes;
+}
+export declare function isCommonMediaClientError(error: any): error is BaseMediaClientError<MediaClientErrorReason, MediaClientErrorMetadata | undefined, Error | undefined, MediaClientErrorAttributes>;
+/** Deserializer ErrorFileState -> CommonMediaClientError */
+export declare const toCommonMediaClientError: (errorFileState: ErrorFileState) => CommonMediaClientError;
+/** Serializer CommonMediaClientError -> ErrorFileState */
+export declare const fromCommonMediaClientError: (id: string, occurrenceKey: string | undefined, error: CommonMediaClientError) => ErrorFileState;

package/dist/types-ts4.5/models/errors/types.d.ts

@@ -1,4 +1,11 @@
+import { type MediaTraceContext } from '@atlaskit/media-common';
+export interface SerializableObject {
+    [key: string]: string | number | boolean | null | undefined | SerializableObject;
+}
 export type MediaClientErrorReason = 'clientOffline' | 'clientAbortedRequest' | 'clientTimeoutRequest' | 'serverInvalidBody' | 'serverBadRequest' | 'serverUnauthorized' | 'serverForbidden' | 'serverNotFound' | 'serverRateLimited' | 'serverInternalError' | 'serverBadGateway' | 'serverUnexpectedError' | 'failedAuthProvider' | 'tokenExpired' | 'missingInitialAuth' | 'emptyAuth' | 'authProviderTimedOut' | 'invalidFileId' | 'emptyItems' | 'zeroVersionFile' | 'emptyFileName' | 'pollingMaxAttemptsExceeded' | 'fileSizeExceedsLimit' | 'deprecatedEndpoint';
+export type MediaClientErrorMetadata = SerializableObject & {
+    traceContext?: MediaTraceContext;
+};
 export interface MediaClientErrorAttributes {
     reason: MediaClientErrorReason;
 }