@atlaskit/media-viewer 49.2.7 → 49.4.0

package/dist/types/analytics/events/operational/download.d.ts

@@ -0,0 +1,9 @@
+import { type FileState } from '@atlaskit/media-client';
+import { type MediaFileEventPayload } from './_mediaFile';
+import { type MediaViewerFailureAttributes } from '../..';
+import { type MediaViewerError } from '../../../errors';
+import { type MediaTraceContext, type SuccessAttributes, type WithFileAttributes, type WithTraceContext } from '@atlaskit/media-common';
+export type DownloadFailedEventPayload = MediaFileEventPayload<MediaViewerFailureAttributes, 'downloadFailed'>;
+export type DownloadSucceededEventPayload = MediaFileEventPayload<SuccessAttributes & WithFileAttributes & WithTraceContext, 'downloadSucceeded'>;
+export declare const createDownloadSucceededEventPayload: (fileState?: FileState, traceContext?: MediaTraceContext) => DownloadSucceededEventPayload;
+export declare const createDownloadFailedEventPayload: (fileId: string, error: MediaViewerError, fileState?: FileState, traceContext?: MediaTraceContext) => DownloadFailedEventPayload;

package/dist/types/components/media-viewer.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="react" />
 import { type MediaViewerProps } from './types';
 import type { MediaViewerWithMediaClientConfigProps } from './types';
-export declare const MediaViewerBase: ({ featureFlags, onClose, selectedItem, collectionName, items, extensions, contextId, }: MediaViewerProps) => JSX.Element;
+export declare const MediaViewerBase: ({ featureFlags, onClose, selectedItem, collectionName, items, extensions, contextId, viewerOptions, }: MediaViewerProps) => JSX.Element;
 export declare const MediaViewerWithMediaClient: (props: MediaViewerWithMediaClientConfigProps) => JSX.Element;

package/dist/types/components/types.d.ts

@@ -2,6 +2,7 @@ import { type Identifier, type MediaClient } from '@atlaskit/media-client';
 import type { WithMediaClientConfigProps } from '@atlaskit/media-client-react';
 import { type MediaFeatureFlags } from '@atlaskit/media-common';
 import { type ReactNode } from 'react';
+import { type ViewerOptionsProps } from '../viewerOptions';
 export type FileStateFlags = {
     wasStatusProcessing: boolean;
     wasStatusUploading: boolean;
@@ -24,6 +25,7 @@ export interface MediaViewerProps {
     readonly featureFlags?: MediaFeatureFlags;
     readonly extensions?: MediaViewerExtensions;
     readonly contextId?: string;
+    readonly viewerOptions?: ViewerOptionsProps;
 }
 export type MediaMessage = {
     source: 'media';

package/dist/types/download.d.ts

@@ -1,24 +1,20 @@
+/// <reference types="react" />
 import { type FileState, type Identifier, type MediaClient } from '@atlaskit/media-client';
-import { MediaButton } from '@atlaskit/media-ui';
-import React from 'react';
-import { type MediaViewerError } from './errors';
-type DownloadButtonProps = React.ComponentProps<typeof MediaButton> & {
-    analyticspayload: Record<string, any>;
-};
-export declare function DownloadButton({ analyticspayload, onClick: providedOnClick, ...rest }: DownloadButtonProps): JSX.Element;
-export declare const createItemDownloader: (file: FileState, mediaClient: MediaClient, collectionName?: string) => () => Promise<void>;
+import { type MediaTraceContext } from '@atlaskit/media-common';
+import { MediaViewerError } from './errors';
 export type ErrorViewDownloadButtonProps = {
     fileState: FileState;
     mediaClient: MediaClient;
     error: MediaViewerError;
     collectionName?: string;
+    traceContext: MediaTraceContext;
 };
-export declare const ErrorViewDownloadButton: (props: ErrorViewDownloadButtonProps) => JSX.Element;
+export declare const ErrorViewDownloadButton: ({ fileState, mediaClient, error, traceContext, collectionName, }: ErrorViewDownloadButtonProps) => JSX.Element;
 export type ToolbarDownloadButtonProps = {
     state: FileState;
     identifier: Identifier;
     mediaClient: MediaClient;
+    traceContext: MediaTraceContext;
 };
-export declare const ToolbarDownloadButton: (props: ToolbarDownloadButtonProps) => JSX.Element | null;
+export declare const ToolbarDownloadButton: ({ state, mediaClient, identifier, traceContext, }: ToolbarDownloadButtonProps) => JSX.Element | null;
 export declare const DisabledToolbarDownloadButton: JSX.Element;
-export {};

package/dist/types/errors.d.ts

@@ -13,8 +13,8 @@ export declare class ArchiveViewerError extends MediaViewerError {
     constructor(primaryReason: ArchiveViewerErrorReason, secondaryError?: Error | undefined, zipEntry?: ZipEntry | undefined);
 }
 export declare function isArchiveViewerError(err: Error): err is ArchiveViewerError;
-export type MediaViewerErrorReason = 'collection-fetch-metadata' | 'header-fetch-metadata' | 'itemviewer-onerror' | 'itemviewer-fetch-metadata' | 'itemviewer-file-error-status' | 'itemviewer-file-failed-processing-status' | 'imageviewer-external-onerror' | 'imageviewer-fetch-url' | 'imageviewer-src-onerror' | 'audioviewer-fetch-url' | 'audioviewer-missing-artefact' | 'audioviewer-playback' | 'videoviewer-fetch-url' | 'videoviewer-missing-artefact' | 'videoviewer-playback' | 'docviewer-fetch-url' | 'docviewer-fetch-pdf' | 'codeviewer-fetch-src' | 'codeviewer-load-src' | 'codeviewer-file-size-exceeds' | 'codeviewer-parse-email' | 'svg-img-error' | 'svg-binary-fetch' | 'svg-unknown-error' | 'unsupported';
-export type ArchiveViewerErrorReason = 'archiveviewer-bundle-loader' | 'archiveviewer-read-binary' | 'archiveviewer-create-url' | 'archiveviewer-imageviewer-onerror' | 'archiveviewer-videoviewer-onerror' | 'archiveviewer-audioviewer-onerror' | 'archiveviewer-docviewer-onerror' | 'archiveviewer-codeviewer-onerror' | 'archiveviewer-codeviewer-file-size-exceeds' | 'archiveviewer-missing-name-src' | 'archiveviewer-unsupported' | 'archiveviewer-encrypted-entry';
+export type MediaViewerErrorReason = 'collection-fetch-metadata' | 'header-fetch-metadata' | 'itemviewer-onerror' | 'itemviewer-fetch-metadata' | 'itemviewer-file-error-status' | 'itemviewer-file-failed-processing-status' | 'imageviewer-external-onerror' | 'imageviewer-fetch-url' | 'imageviewer-src-onerror' | 'audioviewer-fetch-url' | 'audioviewer-missing-artefact' | 'audioviewer-playback' | 'videoviewer-fetch-url' | 'videoviewer-missing-artefact' | 'videoviewer-playback' | 'docviewer-fetch-url' | 'docviewer-fetch-pdf' | 'codeviewer-fetch-src' | 'codeviewer-load-src' | 'codeviewer-file-size-exceeds' | 'codeviewer-parse-email' | 'svg-img-error' | 'svg-binary-fetch' | 'svg-unknown-error' | 'unsupported' | 'custom-viewer-error' | 'download';
+export type ArchiveViewerErrorReason = 'archiveviewer-bundle-loader' | 'archiveviewer-read-binary' | 'archiveviewer-create-url' | 'archiveviewer-imageviewer-onerror' | 'archiveviewer-videoviewer-onerror' | 'archiveviewer-audioviewer-onerror' | 'archiveviewer-docviewer-onerror' | 'archiveviewer-codeviewer-onerror' | 'archiveviewer-codeviewer-file-size-exceeds' | 'archiveviewer-missing-name-src' | 'archiveviewer-unsupported' | 'archiveviewer-encrypted-entry' | 'archiveviewer-customrenderer-onerror';
 export type PrimaryErrorReason = MediaViewerErrorReason | ArchiveViewerErrorReason;
 export type SecondaryErrorReason = MediaClientErrorReason | 'unknown' | 'nativeError' | undefined;
 export declare function getPrimaryErrorReason(error: MediaViewerError): PrimaryErrorReason;

package/dist/types/header.d.ts

@@ -2,7 +2,7 @@ import React from 'react';
 import { type Identifier } from '@atlaskit/media-client';
 import { type WrappedComponentProps } from 'react-intl-next';
 import { type MediaViewerExtensions } from './components/types';
-import { type MediaFeatureFlags } from '@atlaskit/media-common';
+import { type MediaFeatureFlags, type MediaTraceContext } from '@atlaskit/media-common';
 export type Props = {
     readonly identifier: Identifier;
     readonly onClose?: () => void;
@@ -12,7 +12,8 @@ export type Props = {
     readonly featureFlags?: MediaFeatureFlags;
     readonly onSetArchiveSideBarVisible?: (isVisible: boolean) => void;
     readonly isArchiveSideBarVisible?: boolean;
+    traceContext: MediaTraceContext;
 };
-export declare const Header: ({ isArchiveSideBarVisible, extensions, isSidebarVisible, onSidebarButtonClick, identifier, onSetArchiveSideBarVisible, }: Props & WrappedComponentProps) => JSX.Element;
+export declare const Header: ({ isArchiveSideBarVisible, extensions, isSidebarVisible, onSidebarButtonClick, identifier, onSetArchiveSideBarVisible, traceContext, }: Props & WrappedComponentProps) => JSX.Element;
 declare const _default: React.FC<Props>;
 export default _default;

package/dist/types/index.d.ts

@@ -1,2 +1,3 @@
 export { default as MediaViewer } from './components/media-viewer-loader';
 export type { MediaViewerExtensions, MediaViewerExtensionsActions, MediaViewerProps, MediaMessage, } from './components/types';
+export type { ViewerOptionsProps, CustomRendererConfig, CustomRendererStateProps, CustomRendererProps, ArchiveFileItem, } from './viewerOptions';

package/dist/types/item-viewer.d.ts

@@ -4,24 +4,29 @@ import { type WithShowControlMethodProp } from '@atlaskit/media-ui';
 import { Outcome } from './domain';
 import { MediaViewerError } from './errors';
 import { type WithAnalyticsEventsProps } from '@atlaskit/analytics-next';
-import { type MediaFeatureFlags } from '@atlaskit/media-common';
+import { type MediaFeatureFlags, type MediaTraceContext } from '@atlaskit/media-common';
+import { type ViewerOptionsProps } from './viewerOptions';
 export type Props = Readonly<{
     identifier: Identifier;
     onClose?: () => void;
     previewCount: number;
     contextId?: string;
     featureFlags?: MediaFeatureFlags;
+    viewerOptions?: ViewerOptionsProps;
+    traceContext: MediaTraceContext;
 }> & WithAnalyticsEventsProps & WithShowControlMethodProp;
 export type FileItem = FileState | 'external-image';
 export type State = Outcome<FileItem, MediaViewerError>;
 export declare const isExternalImageItem: (fileItem: FileItem) => fileItem is "external-image";
 export declare const isFileStateItem: (fileItem: FileItem) => fileItem is FileState;
 export declare const MAX_FILE_SIZE_SUPPORTED_BY_CODEVIEWER: number;
-export declare const ItemViewerBase: ({ identifier, showControls, onClose, previewCount, contextId, createAnalyticsEvent, }: Props) => React.ReactElement | null;
+export declare const ItemViewerBase: ({ identifier, showControls, onClose, previewCount, contextId, createAnalyticsEvent, viewerOptions, traceContext, }: Props) => React.ReactElement | null;
 export declare const ItemViewer: React.ForwardRefExoticComponent<Omit<Readonly<{
     identifier: Identifier;
     onClose?: (() => void) | undefined;
     previewCount: number;
     contextId?: string | undefined;
     featureFlags?: MediaFeatureFlags | undefined;
+    viewerOptions?: ViewerOptionsProps | undefined;
+    traceContext: MediaTraceContext;
 }> & WithShowControlMethodProp, keyof WithAnalyticsEventsProps> & React.RefAttributes<any>>;

package/dist/types/list.d.ts

@@ -3,6 +3,7 @@ import { type Identifier } from '@atlaskit/media-client';
 import { type WithShowControlMethodProp } from '@atlaskit/media-ui';
 import { type MediaViewerExtensions } from './components/types';
 import { type MediaFeatureFlags } from '@atlaskit/media-common';
+import { type ViewerOptionsProps } from './viewerOptions';
 export type Props = Readonly<{
     onClose?: () => void;
     onNavigationChange?: (selectedItem: Identifier) => void;
@@ -13,10 +14,11 @@ export type Props = Readonly<{
     isSidebarVisible?: boolean;
     contextId?: string;
     featureFlags?: MediaFeatureFlags;
+    viewerOptions?: ViewerOptionsProps;
 } & WithShowControlMethodProp>;
 export type State = {
     selectedItem: Identifier;
     previewCount: number;
     isArchiveSideBarVisible: boolean;
 };
-export declare const List: ({ defaultSelectedItem, onClose, showControls, extensions, onSidebarButtonClick, contextId, featureFlags, isSidebarVisible, onNavigationChange, items, }: Props) => JSX.Element;
+export declare const List: ({ defaultSelectedItem, onClose, showControls, extensions, onSidebarButtonClick, contextId, featureFlags, isSidebarVisible, onNavigationChange, items, viewerOptions, }: Props) => JSX.Element;

package/dist/types/media-viewer.d.ts

@@ -2,6 +2,7 @@ import React from 'react';
 import { type Identifier } from '@atlaskit/media-client';
 import { type MediaFeatureFlags } from '@atlaskit/media-common';
 import { type MediaViewerExtensions } from './components/types';
+import { type ViewerOptionsProps } from './viewerOptions';
 export type Props = {
     onClose?: () => void;
     selectedItem?: Identifier;
@@ -10,5 +11,6 @@ export type Props = {
     extensions?: MediaViewerExtensions;
     contextId?: string;
     innerRef?: React.Ref<HTMLDivElement>;
+    viewerOptions?: ViewerOptionsProps;
 };
 export declare const MediaViewer: React.ComponentType<Props>;

package/dist/types/viewerOptions.d.ts

@@ -0,0 +1,21 @@
+/// <reference types="react" />
+import { type NonErrorFileState } from '@atlaskit/media-client';
+export interface ViewerOptionsProps {
+    customRenderers?: CustomRendererConfig[];
+}
+export interface CustomRendererConfig {
+    shouldUseCustomRenderer: (props: CustomRendererStateProps) => boolean;
+    renderContent: (props: CustomRendererProps) => React.ReactNode;
+}
+export interface CustomRendererStateProps {
+    fileItem: NonErrorFileState;
+    archiveFileItem?: ArchiveFileItem;
+}
+export interface CustomRendererProps extends CustomRendererStateProps {
+    getBinaryContent: () => Promise<Blob>;
+    onLoad: () => void;
+    onError: (error: Error) => void;
+}
+export interface ArchiveFileItem {
+    name: string;
+}

package/dist/types/viewers/archiveSidebar/types.d.ts

@@ -1,9 +1,13 @@
 import { type MediaClient, type FileState, type ErrorFileState } from '@atlaskit/media-client';
 import { type ArchiveViewerError } from '../../errors';
+import { type ViewerOptionsProps } from '../../viewerOptions';
+import { type MediaTraceContext } from '@atlaskit/media-common';
 export type ArchiveViewerProps = {
     item: Exclude<FileState, ErrorFileState>;
     mediaClient: MediaClient;
     collectionName?: string;
     onError: (error: ArchiveViewerError) => void;
     onSuccess: () => void;
+    viewerOptions?: ViewerOptionsProps;
+    traceContext: MediaTraceContext;
 };

package/dist/types/viewers/audio.d.ts

@@ -4,6 +4,7 @@ import { Outcome } from '../domain';
 import { MediaViewerError } from '../errors';
 import { type BaseState, BaseViewer } from './base-viewer';
 import { type WithShowControlMethodProp } from '@atlaskit/media-ui';
+import { type MediaTraceContext } from '@atlaskit/media-common';
 export type Props = Readonly<{
     item: FileState;
     mediaClient: MediaClient;
@@ -11,6 +12,7 @@ export type Props = Readonly<{
     previewCount: number;
     onCanPlay: () => void;
     onError: (error: MediaViewerError) => void;
+    traceContext: MediaTraceContext;
 } & WithShowControlMethodProp>;
 export type State = BaseState<string> & {
     coverUrl?: string;

package/dist/types/viewers/base-viewer.d.ts

@@ -2,10 +2,12 @@ import React from 'react';
 import { type MediaClient, type FileState } from '@atlaskit/media-client';
 import { type Outcome } from '../domain';
 import { type MediaViewerError } from '../errors';
+import { type MediaTraceContext } from '@atlaskit/media-common';
 export type BaseProps = {
     mediaClient: MediaClient;
     item: FileState;
     collectionName?: string;
+    traceContext: MediaTraceContext;
 };
 export type BaseState<Content> = {
     content: Outcome<Content, MediaViewerError>;

package/dist/types/viewers/codeViewer/index.d.ts

@@ -4,6 +4,7 @@ import { Outcome } from '../../domain';
 import { MediaViewerError } from '../../errors';
 import { type Props as RendererProps } from './codeViewerRenderer';
 import { BaseViewer } from '../base-viewer';
+import { type MediaTraceContext } from '@atlaskit/media-common';
 export type Props = {
     mediaClient: MediaClient;
     item: Exclude<FileState, ErrorFileState>;
@@ -11,6 +12,7 @@ export type Props = {
     onClose?: () => void;
     onError: (error: MediaViewerError) => void;
     onSuccess: () => void;
+    traceContext: MediaTraceContext;
 };
 export declare class CodeViewer extends BaseViewer<string, Props> {
     static CodeViewerComponent: ComponentClass<RendererProps>;

package/dist/types/viewers/customViewer/customViewer.d.ts

@@ -0,0 +1,12 @@
+/// <reference types="react" />
+import type { FileState, MediaClient, NonErrorFileState } from '@atlaskit/media-client';
+import { MediaViewerError } from '../../errors';
+import type { CustomRendererConfig } from '../../viewerOptions';
+export type Props = {
+    mediaClient: MediaClient;
+    item: NonErrorFileState;
+    customRendererConfig: CustomRendererConfig;
+    onError: (error: MediaViewerError, fileItem?: FileState) => void;
+    onSuccess: () => void;
+};
+export declare const CustomViewer: ({ mediaClient, item, customRendererConfig, onSuccess, onError, }: Props) => JSX.Element;

package/dist/types/viewers/doc/index.d.ts

@@ -3,6 +3,7 @@ import { type MediaClient, type FileState } from '@atlaskit/media-client';
 import { Outcome } from '../../domain';
 import { MediaViewerError } from '../../errors';
 import { BaseViewer } from '../base-viewer';
+import { type MediaTraceContext } from '@atlaskit/media-common';
 export type Props = {
     mediaClient: MediaClient;
     item: FileState;
@@ -10,6 +11,7 @@ export type Props = {
     onClose?: () => void;
     onError: (error: MediaViewerError) => void;
     onSuccess: () => void;
+    traceContext: MediaTraceContext;
 };
 export type State = {
     content: Outcome<string, MediaViewerError>;

package/dist/types/viewers/image/index.d.ts

@@ -13,7 +13,7 @@ export type ImageViewerProps = {
     onError: (error: MediaViewerError) => void;
     onClose?: () => void;
     contextId?: string;
-    traceContext?: MediaTraceContext;
+    traceContext: MediaTraceContext;
 };
 export interface ImageViewerContent {
     objectUrl: ObjectUrl;

package/dist/types/viewers/video.d.ts

@@ -4,6 +4,7 @@ import { type WithShowControlMethodProp } from '@atlaskit/media-ui';
 import { Outcome } from '../domain';
 import { MediaViewerError } from '../errors';
 import { type BaseState, BaseViewer } from './base-viewer';
+import { type MediaTraceContext } from '@atlaskit/media-common';
 export type Props = Readonly<{
     item: FileState;
     mediaClient: MediaClient;
@@ -11,6 +12,7 @@ export type Props = Readonly<{
     previewCount: number;
     onCanPlay: () => void;
     onError: (error: MediaViewerError) => void;
+    traceContext: MediaTraceContext;
 } & WithShowControlMethodProp>;
 export type State = BaseState<string> & {
     isHDActive: boolean;

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

@@ -1,5 +1,6 @@
 import { type CommencedEventPayload } from './operational/commenced';
 import { type LoadFailedEventPayload } from './operational/loadFailed';
+import { type DownloadFailedEventPayload, type DownloadSucceededEventPayload } from './operational/download';
 import { type LoadSucceededEventPayload } from './operational/loadSucceeded';
 import { type PreviewUnsupportedEventPayload } from './operational/previewUnsupported';
 import { type ZipEntryLoadFailedEventPayload } from './operational/zipEntryLoadFailed';
@@ -13,4 +14,4 @@ import { type FailedPreviewDownloadButtonClickedEventPayload } from './ui/failed
 import { type NavigatedEventPayload } from './ui/navigated';
 import { type ZoomInButtonClickEventPayload } from './ui/zoomInButtonClicked';
 import { type ZoomOutButtonClickEventPayload } from './ui/zoomOutButtonClicked';
-export type MediaViewerEventPayload = CommencedEventPayload | LoadFailedEventPayload | LoadSucceededEventPayload | PreviewUnsupportedEventPayload | ZipEntryLoadFailedEventPayload | ZipEntryLoadSucceededEventPayload | ModalEventPayload | PdfPasswordInputScreenEventPayload | PasswordPdfScreenEventPayload | ClosedEventPayload | DownloadButtonClickedEventPayload | FailedPreviewDownloadButtonClickedEventPayload | NavigatedEventPayload | ZoomInButtonClickEventPayload | ZoomOutButtonClickEventPayload;
+export type MediaViewerEventPayload = CommencedEventPayload | LoadFailedEventPayload | LoadSucceededEventPayload | PreviewUnsupportedEventPayload | ZipEntryLoadFailedEventPayload | ZipEntryLoadSucceededEventPayload | ModalEventPayload | PdfPasswordInputScreenEventPayload | PasswordPdfScreenEventPayload | ClosedEventPayload | DownloadButtonClickedEventPayload | FailedPreviewDownloadButtonClickedEventPayload | NavigatedEventPayload | ZoomInButtonClickEventPayload | ZoomOutButtonClickEventPayload | DownloadFailedEventPayload | DownloadSucceededEventPayload;

package/dist/types-ts4.5/analytics/events/operational/_mediaFile.d.ts

@@ -1,3 +1,3 @@
 import { type OperationalEventPayload, type OperationalAttributes } from '@atlaskit/media-common';
 /** common definition used by other mediaFile events */
-export type MediaFileEventPayload<Attributes extends OperationalAttributes, Action extends 'commenced' | 'loadSucceeded' | 'loadFailed' | 'previewUnsupported' | 'zipEntryLoadSucceeded' | 'zipEntryLoadFailed'> = OperationalEventPayload<Attributes, Action, 'mediaFile'>;
+export type MediaFileEventPayload<Attributes extends OperationalAttributes, Action extends 'commenced' | 'loadSucceeded' | 'loadFailed' | 'previewUnsupported' | 'zipEntryLoadSucceeded' | 'zipEntryLoadFailed' | 'downloadSucceeded' | 'downloadFailed'> = OperationalEventPayload<Attributes, Action, 'mediaFile'>;

package/dist/types-ts4.5/analytics/events/operational/download.d.ts

@@ -0,0 +1,9 @@
+import { type FileState } from '@atlaskit/media-client';
+import { type MediaFileEventPayload } from './_mediaFile';
+import { type MediaViewerFailureAttributes } from '../..';
+import { type MediaViewerError } from '../../../errors';
+import { type MediaTraceContext, type SuccessAttributes, type WithFileAttributes, type WithTraceContext } from '@atlaskit/media-common';
+export type DownloadFailedEventPayload = MediaFileEventPayload<MediaViewerFailureAttributes, 'downloadFailed'>;
+export type DownloadSucceededEventPayload = MediaFileEventPayload<SuccessAttributes & WithFileAttributes & WithTraceContext, 'downloadSucceeded'>;
+export declare const createDownloadSucceededEventPayload: (fileState?: FileState, traceContext?: MediaTraceContext) => DownloadSucceededEventPayload;
+export declare const createDownloadFailedEventPayload: (fileId: string, error: MediaViewerError, fileState?: FileState, traceContext?: MediaTraceContext) => DownloadFailedEventPayload;

package/dist/types-ts4.5/components/media-viewer.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="react" />
 import { type MediaViewerProps } from './types';
 import type { MediaViewerWithMediaClientConfigProps } from './types';
-export declare const MediaViewerBase: ({ featureFlags, onClose, selectedItem, collectionName, items, extensions, contextId, }: MediaViewerProps) => JSX.Element;
+export declare const MediaViewerBase: ({ featureFlags, onClose, selectedItem, collectionName, items, extensions, contextId, viewerOptions, }: MediaViewerProps) => JSX.Element;
 export declare const MediaViewerWithMediaClient: (props: MediaViewerWithMediaClientConfigProps) => JSX.Element;

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

@@ -2,6 +2,7 @@ import { type Identifier, type MediaClient } from '@atlaskit/media-client';
 import type { WithMediaClientConfigProps } from '@atlaskit/media-client-react';
 import { type MediaFeatureFlags } from '@atlaskit/media-common';
 import { type ReactNode } from 'react';
+import { type ViewerOptionsProps } from '../viewerOptions';
 export type FileStateFlags = {
     wasStatusProcessing: boolean;
     wasStatusUploading: boolean;
@@ -24,6 +25,7 @@ export interface MediaViewerProps {
     readonly featureFlags?: MediaFeatureFlags;
     readonly extensions?: MediaViewerExtensions;
     readonly contextId?: string;
+    readonly viewerOptions?: ViewerOptionsProps;
 }
 export type MediaMessage = {
     source: 'media';

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

@@ -1,24 +1,20 @@
+/// <reference types="react" />
 import { type FileState, type Identifier, type MediaClient } from '@atlaskit/media-client';
-import { MediaButton } from '@atlaskit/media-ui';
-import React from 'react';
-import { type MediaViewerError } from './errors';
-type DownloadButtonProps = React.ComponentProps<typeof MediaButton> & {
-    analyticspayload: Record<string, any>;
-};
-export declare function DownloadButton({ analyticspayload, onClick: providedOnClick, ...rest }: DownloadButtonProps): JSX.Element;
-export declare const createItemDownloader: (file: FileState, mediaClient: MediaClient, collectionName?: string) => () => Promise<void>;
+import { type MediaTraceContext } from '@atlaskit/media-common';
+import { MediaViewerError } from './errors';
 export type ErrorViewDownloadButtonProps = {
     fileState: FileState;
     mediaClient: MediaClient;
     error: MediaViewerError;
     collectionName?: string;
+    traceContext: MediaTraceContext;
 };
-export declare const ErrorViewDownloadButton: (props: ErrorViewDownloadButtonProps) => JSX.Element;
+export declare const ErrorViewDownloadButton: ({ fileState, mediaClient, error, traceContext, collectionName, }: ErrorViewDownloadButtonProps) => JSX.Element;
 export type ToolbarDownloadButtonProps = {
     state: FileState;
     identifier: Identifier;
     mediaClient: MediaClient;
+    traceContext: MediaTraceContext;
 };
-export declare const ToolbarDownloadButton: (props: ToolbarDownloadButtonProps) => JSX.Element | null;
+export declare const ToolbarDownloadButton: ({ state, mediaClient, identifier, traceContext, }: ToolbarDownloadButtonProps) => JSX.Element | null;
 export declare const DisabledToolbarDownloadButton: JSX.Element;
-export {};

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

@@ -13,8 +13,8 @@ export declare class ArchiveViewerError extends MediaViewerError {
     constructor(primaryReason: ArchiveViewerErrorReason, secondaryError?: Error | undefined, zipEntry?: ZipEntry | undefined);
 }
 export declare function isArchiveViewerError(err: Error): err is ArchiveViewerError;
-export type MediaViewerErrorReason = 'collection-fetch-metadata' | 'header-fetch-metadata' | 'itemviewer-onerror' | 'itemviewer-fetch-metadata' | 'itemviewer-file-error-status' | 'itemviewer-file-failed-processing-status' | 'imageviewer-external-onerror' | 'imageviewer-fetch-url' | 'imageviewer-src-onerror' | 'audioviewer-fetch-url' | 'audioviewer-missing-artefact' | 'audioviewer-playback' | 'videoviewer-fetch-url' | 'videoviewer-missing-artefact' | 'videoviewer-playback' | 'docviewer-fetch-url' | 'docviewer-fetch-pdf' | 'codeviewer-fetch-src' | 'codeviewer-load-src' | 'codeviewer-file-size-exceeds' | 'codeviewer-parse-email' | 'svg-img-error' | 'svg-binary-fetch' | 'svg-unknown-error' | 'unsupported';
-export type ArchiveViewerErrorReason = 'archiveviewer-bundle-loader' | 'archiveviewer-read-binary' | 'archiveviewer-create-url' | 'archiveviewer-imageviewer-onerror' | 'archiveviewer-videoviewer-onerror' | 'archiveviewer-audioviewer-onerror' | 'archiveviewer-docviewer-onerror' | 'archiveviewer-codeviewer-onerror' | 'archiveviewer-codeviewer-file-size-exceeds' | 'archiveviewer-missing-name-src' | 'archiveviewer-unsupported' | 'archiveviewer-encrypted-entry';
+export type MediaViewerErrorReason = 'collection-fetch-metadata' | 'header-fetch-metadata' | 'itemviewer-onerror' | 'itemviewer-fetch-metadata' | 'itemviewer-file-error-status' | 'itemviewer-file-failed-processing-status' | 'imageviewer-external-onerror' | 'imageviewer-fetch-url' | 'imageviewer-src-onerror' | 'audioviewer-fetch-url' | 'audioviewer-missing-artefact' | 'audioviewer-playback' | 'videoviewer-fetch-url' | 'videoviewer-missing-artefact' | 'videoviewer-playback' | 'docviewer-fetch-url' | 'docviewer-fetch-pdf' | 'codeviewer-fetch-src' | 'codeviewer-load-src' | 'codeviewer-file-size-exceeds' | 'codeviewer-parse-email' | 'svg-img-error' | 'svg-binary-fetch' | 'svg-unknown-error' | 'unsupported' | 'custom-viewer-error' | 'download';
+export type ArchiveViewerErrorReason = 'archiveviewer-bundle-loader' | 'archiveviewer-read-binary' | 'archiveviewer-create-url' | 'archiveviewer-imageviewer-onerror' | 'archiveviewer-videoviewer-onerror' | 'archiveviewer-audioviewer-onerror' | 'archiveviewer-docviewer-onerror' | 'archiveviewer-codeviewer-onerror' | 'archiveviewer-codeviewer-file-size-exceeds' | 'archiveviewer-missing-name-src' | 'archiveviewer-unsupported' | 'archiveviewer-encrypted-entry' | 'archiveviewer-customrenderer-onerror';
 export type PrimaryErrorReason = MediaViewerErrorReason | ArchiveViewerErrorReason;
 export type SecondaryErrorReason = MediaClientErrorReason | 'unknown' | 'nativeError' | undefined;
 export declare function getPrimaryErrorReason(error: MediaViewerError): PrimaryErrorReason;

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

@@ -2,7 +2,7 @@ import React from 'react';
 import { type Identifier } from '@atlaskit/media-client';
 import { type WrappedComponentProps } from 'react-intl-next';
 import { type MediaViewerExtensions } from './components/types';
-import { type MediaFeatureFlags } from '@atlaskit/media-common';
+import { type MediaFeatureFlags, type MediaTraceContext } from '@atlaskit/media-common';
 export type Props = {
     readonly identifier: Identifier;
     readonly onClose?: () => void;
@@ -12,7 +12,8 @@ export type Props = {
     readonly featureFlags?: MediaFeatureFlags;
     readonly onSetArchiveSideBarVisible?: (isVisible: boolean) => void;
     readonly isArchiveSideBarVisible?: boolean;
+    traceContext: MediaTraceContext;
 };
-export declare const Header: ({ isArchiveSideBarVisible, extensions, isSidebarVisible, onSidebarButtonClick, identifier, onSetArchiveSideBarVisible, }: Props & WrappedComponentProps) => JSX.Element;
+export declare const Header: ({ isArchiveSideBarVisible, extensions, isSidebarVisible, onSidebarButtonClick, identifier, onSetArchiveSideBarVisible, traceContext, }: Props & WrappedComponentProps) => JSX.Element;
 declare const _default: React.FC<Props>;
 export default _default;

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

@@ -1,2 +1,3 @@
 export { default as MediaViewer } from './components/media-viewer-loader';
 export type { MediaViewerExtensions, MediaViewerExtensionsActions, MediaViewerProps, MediaMessage, } from './components/types';
+export type { ViewerOptionsProps, CustomRendererConfig, CustomRendererStateProps, CustomRendererProps, ArchiveFileItem, } from './viewerOptions';

package/dist/types-ts4.5/item-viewer.d.ts

@@ -4,24 +4,29 @@ import { type WithShowControlMethodProp } from '@atlaskit/media-ui';
 import { Outcome } from './domain';
 import { MediaViewerError } from './errors';
 import { type WithAnalyticsEventsProps } from '@atlaskit/analytics-next';
-import { type MediaFeatureFlags } from '@atlaskit/media-common';
+import { type MediaFeatureFlags, type MediaTraceContext } from '@atlaskit/media-common';
+import { type ViewerOptionsProps } from './viewerOptions';
 export type Props = Readonly<{
     identifier: Identifier;
     onClose?: () => void;
     previewCount: number;
     contextId?: string;
     featureFlags?: MediaFeatureFlags;
+    viewerOptions?: ViewerOptionsProps;
+    traceContext: MediaTraceContext;
 }> & WithAnalyticsEventsProps & WithShowControlMethodProp;
 export type FileItem = FileState | 'external-image';
 export type State = Outcome<FileItem, MediaViewerError>;
 export declare const isExternalImageItem: (fileItem: FileItem) => fileItem is "external-image";
 export declare const isFileStateItem: (fileItem: FileItem) => fileItem is FileState;
 export declare const MAX_FILE_SIZE_SUPPORTED_BY_CODEVIEWER: number;
-export declare const ItemViewerBase: ({ identifier, showControls, onClose, previewCount, contextId, createAnalyticsEvent, }: Props) => React.ReactElement | null;
+export declare const ItemViewerBase: ({ identifier, showControls, onClose, previewCount, contextId, createAnalyticsEvent, viewerOptions, traceContext, }: Props) => React.ReactElement | null;
 export declare const ItemViewer: React.ForwardRefExoticComponent<Omit<Readonly<{
     identifier: Identifier;
     onClose?: (() => void) | undefined;
     previewCount: number;
     contextId?: string | undefined;
     featureFlags?: MediaFeatureFlags | undefined;
+    viewerOptions?: ViewerOptionsProps | undefined;
+    traceContext: MediaTraceContext;
 }> & WithShowControlMethodProp, keyof WithAnalyticsEventsProps> & React.RefAttributes<any>>;

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

@@ -3,6 +3,7 @@ import { type Identifier } from '@atlaskit/media-client';
 import { type WithShowControlMethodProp } from '@atlaskit/media-ui';
 import { type MediaViewerExtensions } from './components/types';
 import { type MediaFeatureFlags } from '@atlaskit/media-common';
+import { type ViewerOptionsProps } from './viewerOptions';
 export type Props = Readonly<{
     onClose?: () => void;
     onNavigationChange?: (selectedItem: Identifier) => void;
@@ -13,10 +14,11 @@ export type Props = Readonly<{
     isSidebarVisible?: boolean;
     contextId?: string;
     featureFlags?: MediaFeatureFlags;
+    viewerOptions?: ViewerOptionsProps;
 } & WithShowControlMethodProp>;
 export type State = {
     selectedItem: Identifier;
     previewCount: number;
     isArchiveSideBarVisible: boolean;
 };
-export declare const List: ({ defaultSelectedItem, onClose, showControls, extensions, onSidebarButtonClick, contextId, featureFlags, isSidebarVisible, onNavigationChange, items, }: Props) => JSX.Element;
+export declare const List: ({ defaultSelectedItem, onClose, showControls, extensions, onSidebarButtonClick, contextId, featureFlags, isSidebarVisible, onNavigationChange, items, viewerOptions, }: Props) => JSX.Element;

package/dist/types-ts4.5/media-viewer.d.ts

@@ -2,6 +2,7 @@ import React from 'react';
 import { type Identifier } from '@atlaskit/media-client';
 import { type MediaFeatureFlags } from '@atlaskit/media-common';
 import { type MediaViewerExtensions } from './components/types';
+import { type ViewerOptionsProps } from './viewerOptions';
 export type Props = {
     onClose?: () => void;
     selectedItem?: Identifier;
@@ -10,5 +11,6 @@ export type Props = {
     extensions?: MediaViewerExtensions;
     contextId?: string;
     innerRef?: React.Ref<HTMLDivElement>;
+    viewerOptions?: ViewerOptionsProps;
 };
 export declare const MediaViewer: React.ComponentType<Props>;

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

@@ -0,0 +1,21 @@
+/// <reference types="react" />
+import { type NonErrorFileState } from '@atlaskit/media-client';
+export interface ViewerOptionsProps {
+    customRenderers?: CustomRendererConfig[];
+}
+export interface CustomRendererConfig {
+    shouldUseCustomRenderer: (props: CustomRendererStateProps) => boolean;
+    renderContent: (props: CustomRendererProps) => React.ReactNode;
+}
+export interface CustomRendererStateProps {
+    fileItem: NonErrorFileState;
+    archiveFileItem?: ArchiveFileItem;
+}
+export interface CustomRendererProps extends CustomRendererStateProps {
+    getBinaryContent: () => Promise<Blob>;
+    onLoad: () => void;
+    onError: (error: Error) => void;
+}
+export interface ArchiveFileItem {
+    name: string;
+}

package/dist/types-ts4.5/viewers/archiveSidebar/types.d.ts

@@ -1,9 +1,13 @@
 import { type MediaClient, type FileState, type ErrorFileState } from '@atlaskit/media-client';
 import { type ArchiveViewerError } from '../../errors';
+import { type ViewerOptionsProps } from '../../viewerOptions';
+import { type MediaTraceContext } from '@atlaskit/media-common';
 export type ArchiveViewerProps = {
     item: Exclude<FileState, ErrorFileState>;
     mediaClient: MediaClient;
     collectionName?: string;
     onError: (error: ArchiveViewerError) => void;
     onSuccess: () => void;
+    viewerOptions?: ViewerOptionsProps;
+    traceContext: MediaTraceContext;
 };

package/dist/types-ts4.5/viewers/audio.d.ts

@@ -4,6 +4,7 @@ import { Outcome } from '../domain';
 import { MediaViewerError } from '../errors';
 import { type BaseState, BaseViewer } from './base-viewer';
 import { type WithShowControlMethodProp } from '@atlaskit/media-ui';
+import { type MediaTraceContext } from '@atlaskit/media-common';
 export type Props = Readonly<{
     item: FileState;
     mediaClient: MediaClient;
@@ -11,6 +12,7 @@ export type Props = Readonly<{
     previewCount: number;
     onCanPlay: () => void;
     onError: (error: MediaViewerError) => void;
+    traceContext: MediaTraceContext;
 } & WithShowControlMethodProp>;
 export type State = BaseState<string> & {
     coverUrl?: string;

package/dist/types-ts4.5/viewers/base-viewer.d.ts

@@ -2,10 +2,12 @@ import React from 'react';
 import { type MediaClient, type FileState } from '@atlaskit/media-client';
 import { type Outcome } from '../domain';
 import { type MediaViewerError } from '../errors';
+import { type MediaTraceContext } from '@atlaskit/media-common';
 export type BaseProps = {
     mediaClient: MediaClient;
     item: FileState;
     collectionName?: string;
+    traceContext: MediaTraceContext;
 };
 export type BaseState<Content> = {
     content: Outcome<Content, MediaViewerError>;

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

@@ -4,6 +4,7 @@ import { Outcome } from '../../domain';
 import { MediaViewerError } from '../../errors';
 import { type Props as RendererProps } from './codeViewerRenderer';
 import { BaseViewer } from '../base-viewer';
+import { type MediaTraceContext } from '@atlaskit/media-common';
 export type Props = {
     mediaClient: MediaClient;
     item: Exclude<FileState, ErrorFileState>;
@@ -11,6 +12,7 @@ export type Props = {
     onClose?: () => void;
     onError: (error: MediaViewerError) => void;
     onSuccess: () => void;
+    traceContext: MediaTraceContext;
 };
 export declare class CodeViewer extends BaseViewer<string, Props> {
     static CodeViewerComponent: ComponentClass<RendererProps>;