@atlaskit/media-viewer 54.8.21 → 54.8.23

package/dist/es2019/errors.js

@@ -1,167 +1 @@
-import { isCommonMediaClientError, isErrorFileState } from '@atlaskit/media-client';
-import { isImageMimeTypeSupportedByBrowser, isVideoMimeTypeSupportedByBrowser } from '@atlaskit/media-common/isMimeTypeSupportedByBrowser';
-export class MediaViewerError extends Error {
-  constructor(primaryReason, secondaryError) {
-    super(primaryReason);
-
-    // https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-2.html#support-for-newtarget
-    this.primaryReason = primaryReason;
-    this.secondaryError = secondaryError;
-    Object.setPrototypeOf(this, new.target.prototype);
-
-    // https://v8.dev/docs/stack-trace-api
-    if ('captureStackTrace' in Error) {
-      Error.captureStackTrace(this, new.target);
-    }
-  }
-}
-export function isMediaViewerError(err) {
-  return err instanceof MediaViewerError;
-}
-export class ArchiveViewerError extends MediaViewerError {
-  constructor(primaryReason, secondaryError, zipEntry) {
-    super(primaryReason, secondaryError);
-    this.primaryReason = primaryReason;
-    this.secondaryError = secondaryError;
-    this.zipEntry = zipEntry;
-  }
-}
-export function isArchiveViewerError(err) {
-  return err instanceof ArchiveViewerError;
-}
-// not supplied, so just a primary reason
-
-export function getPrimaryErrorReason(error) {
-  return error.primaryReason;
-}
-export function getSecondaryErrorReason(error) {
-  const {
-    secondaryError
-  } = error;
-  if (isCommonMediaClientError(secondaryError)) {
-    return secondaryError.reason;
-  } else if (secondaryError) {
-    return 'nativeError';
-  } else {
-    return 'unknown';
-  }
-}
-export function getErrorDetail(error) {
-  const {
-    secondaryError
-  } = error || {};
-  if (isCommonMediaClientError(secondaryError)) {
-    var _secondaryError$inner;
-    return ((_secondaryError$inner = secondaryError.innerError) === null || _secondaryError$inner === void 0 ? void 0 : _secondaryError$inner.message) || 'unknown';
-  } else if (secondaryError) {
-    return secondaryError.message;
-  }
-  return 'unknown';
-}
-export function getRequestMetadata(error) {
-  const {
-    secondaryError
-  } = error || {};
-  if (isCommonMediaClientError(secondaryError)) {
-    return secondaryError.metadata;
-  }
-}
-
-/**
- * Classifies the failed `<img>` source into a coarse, non-sensitive enum so we can
- * tell which kind of source failed without leaking the (potentially signed) url.
- */
-export function classifyFailedSrc(currentSrc) {
-  if (!currentSrc) {
-    return 'unknown';
-  }
-  if (currentSrc.startsWith('blob:')) {
-    return 'blob';
-  }
-  if (currentSrc.startsWith('data:')) {
-    return 'data';
-  }
-  if (currentSrc.startsWith('http:') || currentSrc.startsWith('https:')) {
-    return 'remote';
-  }
-  return 'unknown';
-}
-
-/**
- * Builds a descriptive `secondaryError` for an `<img>` onerror so the downstream
- * `loadFailed` analytics event reports a meaningful `error`/`errorDetail` instead of
- * the opaque `unknown`/`unknown`. The returned Error's `message` captures decode
- * diagnostics as a comma-separated `key=value` string (undefined fields are omitted):
- * - whether the browser decoded any pixels (`naturalWidth`/`naturalHeight === 0`)
- * - the file MIME type and whether it is natively browser-decodable
- * - which source failed (preview blob vs. original-binary/HD url)
- *
- * @example
- * // message:
- * "mimeType=image/png, isBrowserDecodable=true, naturalWidth=0, naturalHeight=0, failedSrcType=blob"
- */
-export function buildImgErrorDiagnostics(item, event) {
-  const img = event === null || event === void 0 ? void 0 : event.currentTarget;
-  const mimeType = item && !isErrorFileState(item) ? item.mimeType : undefined;
-  const isBrowserDecodable = !!mimeType && isImageMimeTypeSupportedByBrowser(mimeType);
-  const naturalWidth = img === null || img === void 0 ? void 0 : img.naturalWidth;
-  const naturalHeight = img === null || img === void 0 ? void 0 : img.naturalHeight;
-  const failedSrcType = classifyFailedSrc(img === null || img === void 0 ? void 0 : img.currentSrc);
-  const diagnostics = {
-    mimeType,
-    isBrowserDecodable,
-    naturalWidth,
-    naturalHeight,
-    failedSrcType
-  };
-  const detail = Object.entries(diagnostics).filter(([, value]) => value !== undefined).map(([key, value]) => `${key}=${value}`).join(', ');
-  return new Error(detail);
-}
-
-/**
- * Human-readable names for the four standard `MediaError.code` values, so the
- * downstream analytics `error`/`errorDetail` report a meaningful cause instead of
- * a bare numeric code.
- *
- * @see https://developer.mozilla.org/en-US/docs/Web/API/MediaError/code
- */
-const MEDIA_ERROR_CODE_NAMES = {
-  1: 'MEDIA_ERR_ABORTED',
-  2: 'MEDIA_ERR_NETWORK',
-  3: 'MEDIA_ERR_DECODE',
-  4: 'MEDIA_ERR_SRC_NOT_SUPPORTED'
-};
-
-/**
- * Builds a descriptive `secondaryError` for a `<video>` onerror so the downstream
- * `loadFailed` analytics event reports a meaningful `error`/`errorDetail` instead of
- * the opaque `unknown`/`unknown`. The returned Error's `message` captures playback
- * diagnostics as a comma-separated `key=value` string (undefined fields are omitted):
- * - the native `MediaError.code` and its readable name (e.g. `MEDIA_ERR_DECODE`)
- * - the native `MediaError.message` (browser-provided detail, often empty)
- * - the file MIME type and whether it is natively browser-playable
- * - the file size in bytes (helps distinguish large-file/streaming failures)
- *
- * @example
- * // message:
- * "mediaErrorCode=3, mediaErrorName=MEDIA_ERR_DECODE, mimeType=video/quicktime, isBrowserPlayable=false, fileSize=734003200"
- */
-export function buildVideoErrorDiagnostics(item, mediaError) {
-  const mimeType = item && !isErrorFileState(item) ? item.mimeType : undefined;
-  const isBrowserPlayable = mimeType ? isVideoMimeTypeSupportedByBrowser(mimeType) : undefined;
-  const fileSize = item && !isErrorFileState(item) ? item.size : undefined;
-  const mediaErrorCode = mediaError === null || mediaError === void 0 ? void 0 : mediaError.code;
-  const mediaErrorName = mediaErrorCode !== undefined ? MEDIA_ERROR_CODE_NAMES[mediaErrorCode] : undefined;
-  // A native MediaError.message can be empty; only include it when present.
-  const mediaErrorMessage = (mediaError === null || mediaError === void 0 ? void 0 : mediaError.message) || undefined;
-  const diagnostics = {
-    mediaErrorCode,
-    mediaErrorName,
-    mediaErrorMessage,
-    mimeType,
-    isBrowserPlayable,
-    fileSize
-  };
-  const detail = Object.entries(diagnostics).filter(([, value]) => value !== undefined).map(([key, value]) => `${key}=${value}`).join(', ');
-  return new Error(detail);
-}
+export {};

package/dist/es2019/getErrorDetail.js

@@ -0,0 +1,13 @@
+import { isCommonMediaClientError } from '@atlaskit/media-client';
+export function getErrorDetail(error) {
+  const {
+    secondaryError
+  } = error || {};
+  if (isCommonMediaClientError(secondaryError)) {
+    var _secondaryError$inner;
+    return ((_secondaryError$inner = secondaryError.innerError) === null || _secondaryError$inner === void 0 ? void 0 : _secondaryError$inner.message) || 'unknown';
+  } else if (secondaryError) {
+    return secondaryError.message;
+  }
+  return 'unknown';
+}

package/dist/es2019/getErrorMessageFromError.js

@@ -0,0 +1,7 @@
+import { errorReasonToMessages } from './errorMessage';
+import { getPrimaryErrorReason } from './getPrimaryErrorReason';
+import { getSecondaryErrorReason } from './getSecondaryErrorReason';
+export const getErrorMessageFromError = error => {
+  const matchingRow = errorReasonToMessages.find(row => row[0] === getPrimaryErrorReason(error) || row[0] === getSecondaryErrorReason(error));
+  return matchingRow ? matchingRow[1] : undefined;
+};

package/dist/es2019/getPrimaryErrorReason.js

@@ -0,0 +1,4 @@
+// not supplied, so just a primary reason
+export function getPrimaryErrorReason(error) {
+  return error.primaryReason;
+}

package/dist/es2019/getRequestMetadata.js

@@ -0,0 +1,9 @@
+import { isCommonMediaClientError } from '@atlaskit/media-client';
+export function getRequestMetadata(error) {
+  const {
+    secondaryError
+  } = error || {};
+  if (isCommonMediaClientError(secondaryError)) {
+    return secondaryError.metadata;
+  }
+}

package/dist/es2019/getSecondaryErrorReason.js

@@ -0,0 +1,13 @@
+import { isCommonMediaClientError } from '@atlaskit/media-client';
+export function getSecondaryErrorReason(error) {
+  const {
+    secondaryError
+  } = error;
+  if (isCommonMediaClientError(secondaryError)) {
+    return secondaryError.reason;
+  } else if (secondaryError) {
+    return 'nativeError';
+  } else {
+    return 'unknown';
+  }
+}

package/dist/es2019/header.js

@@ -1,24 +1,25 @@
 import React, { useEffect, useRef, useState } from 'react';
+import { FormattedMessage } from 'react-intl';
 import { isExternalImageIdentifier, isErrorFileState, toCommonMediaClientError } from '@atlaskit/media-client';
+import { useFileState } from '@atlaskit/media-client-react/use-file-state';
+import { useMediaClient } from '@atlaskit/media-client-react/use-media-client';
+import { isZipMimeType } from '@atlaskit/media-common/isZipMimeType';
 import { hideControlsClassName } from '@atlaskit/media-ui/classNames';
-import { messages } from '@atlaskit/media-ui/messages';
-import { toHumanReadableMediaSize } from '@atlaskit/media-ui/humanReadableSize';
-import MediaButton from '@atlaskit/media-ui/MediaButton';
-import { getLanguageType } from '@atlaskit/media-ui/getLanguageType';
 import { getExtension } from '@atlaskit/media-ui/getExtension';
+import { getLanguageType } from '@atlaskit/media-ui/getLanguageType';
+import { toHumanReadableMediaSize } from '@atlaskit/media-ui/humanReadableSize';
 import { isCodeViewerItem } from '@atlaskit/media-ui/isCodeViewerItem';
-import { isZipMimeType } from '@atlaskit/media-common/isZipMimeType';
-import { fg } from '@atlaskit/platform-feature-flags/fg';
-import { FormattedMessage, injectIntl } from 'react-intl';
-import { Outcome } from './domain';
-import { Header as HeaderWrapper, LeftHeader, RightHeader, MetadataWrapper, MetadataSubText, MedatadataTextWrapper, MetadataIconWrapper, MetadataFileName, FormattedMessageWrapper } from './styleWrappers';
-import { ToolbarDownloadButton, DisabledToolbarDownloadButton } from './download';
-import { useFileState } from '@atlaskit/media-client-react/use-file-state';
-import { useMediaClient } from '@atlaskit/media-client-react/use-media-client';
+import MediaButton from '@atlaskit/media-ui/MediaButton';
+import { messages } from '@atlaskit/media-ui/messages';
 import { MimeTypeIcon } from '@atlaskit/media-ui/mime-type-icon';
-import { getFormat } from './viewers/codeViewer/util';
-import { MediaViewerError } from './errors';
+import { fg } from '@atlaskit/platform-feature-flags/fg';
 import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
+import { Outcome } from './domain/outcome';
+import { DisabledToolbarDownloadButton } from './download';
+import { MediaViewerError } from './MediaViewerError';
+import { Header as HeaderWrapper, LeftHeader, RightHeader, MetadataWrapper, MetadataSubText, MedatadataTextWrapper, MetadataIconWrapper, MetadataFileName, FormattedMessageWrapper } from './styleWrappers';
+import { ToolbarDownloadButton } from './ToolbarDownloadButton';
+import { getFormat } from './viewers/codeViewer/getFormat';
 export const Header = ({
   isArchiveSideBarVisible = false,
   extensions,
@@ -191,5 +192,4 @@ export const Header = ({
       fallbackMediaName: fallbackMediaName
     })
   })));
-};
-export default injectIntl(Header);
+};

package/dist/es2019/headerWithIntl.js

@@ -0,0 +1,3 @@
+import { injectIntl } from 'react-intl';
+import { Header } from './header';
+export default injectIntl(Header);

package/dist/es2019/index.js

@@ -1 +1,12 @@
-export { default as MediaViewer } from './components/media-viewer-loader';
+/* eslint-disable @repo/internal/deprecations/deprecation-ticket-required -- VOLTC-139 tracks removal of these deprecated re-export shims. */
+/**
+ * @deprecated Use `import MediaViewer from '@atlaskit/media-viewer/media-viewer-loader'` instead.
+ */
+export { default as MediaViewer } from './components/media-viewer-loader';
+/**
+ * @deprecated Use `import type { MediaViewerExtensions, MediaViewerExtensionsActions, MediaViewerProps, MediaMessage } from '@atlaskit/media-viewer/types'` instead.
+ */
+
+/**
+ * @deprecated Use `import type { ViewerOptionsProps, CustomRendererConfig, CustomRendererStateProps, CustomRendererProps, ArchiveFileItem } from '@atlaskit/media-viewer/viewer-options'` instead.
+ */

package/dist/es2019/isArchiveViewerError.js

@@ -0,0 +1,4 @@
+import { ArchiveViewerError } from './ArchiveViewerError';
+export function isArchiveViewerError(err) {
+  return err instanceof ArchiveViewerError;
+}

package/dist/es2019/isExternalImageItem.js

@@ -0,0 +1,2 @@
+// Consts
+export const isExternalImageItem = fileItem => fileItem === 'external-image';

package/dist/es2019/isFileStateItem.js

@@ -0,0 +1,2 @@
+import { isExternalImageItem } from './isExternalImageItem';
+export const isFileStateItem = fileItem => !isExternalImageItem(fileItem);

package/dist/es2019/isMediaViewerError.js

@@ -0,0 +1,4 @@
+import { MediaViewerError } from './MediaViewerError';
+export function isMediaViewerError(err) {
+  return err instanceof MediaViewerError;
+}