@atlaskit/media-viewer 49.2.6 → 49.3.0

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,11 @@
 import { type MediaClient, type FileState, type ErrorFileState } from '@atlaskit/media-client';
 import { type ArchiveViewerError } from '../../errors';
+import { type ViewerOptionsProps } from '../../viewerOptions';
 export type ArchiveViewerProps = {
     item: Exclude<FileState, ErrorFileState>;
     mediaClient: MediaClient;
     collectionName?: string;
     onError: (error: ArchiveViewerError) => void;
     onSuccess: () => void;
+    viewerOptions?: ViewerOptionsProps;
 };

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-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/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';
+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/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

@@ -5,23 +5,26 @@ import { Outcome } from './domain';
 import { MediaViewerError } from './errors';
 import { type WithAnalyticsEventsProps } from '@atlaskit/analytics-next';
 import { type MediaFeatureFlags } 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;
 }> & 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, }: 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;
 }> & 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,11 @@
 import { type MediaClient, type FileState, type ErrorFileState } from '@atlaskit/media-client';
 import { type ArchiveViewerError } from '../../errors';
+import { type ViewerOptionsProps } from '../../viewerOptions';
 export type ArchiveViewerProps = {
     item: Exclude<FileState, ErrorFileState>;
     mediaClient: MediaClient;
     collectionName?: string;
     onError: (error: ArchiveViewerError) => void;
     onSuccess: () => void;
+    viewerOptions?: ViewerOptionsProps;
 };

package/dist/types-ts4.5/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/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/media-viewer",
-	"version": "49.2.6",
+	"version": "49.3.0",
 	"description": "MediaViewer is Atlassian's powerful solution for viewing files on the web. It's both powerful and extendable yet easy-to-integrate",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -40,18 +40,18 @@
 		"@atlaskit/form": "^10.5.0",
 		"@atlaskit/icon": "^22.24.0",
 		"@atlaskit/icon-file-type": "^6.7.0",
-		"@atlaskit/media-client": "^28.0.0",
+		"@atlaskit/media-client": "^28.2.0",
 		"@atlaskit/media-client-react": "^2.3.0",
 		"@atlaskit/media-common": "^11.7.0",
 		"@atlaskit/media-svg": "^0.2.0",
-		"@atlaskit/media-ui": "^26.0.0",
+		"@atlaskit/media-ui": "^26.1.0",
 		"@atlaskit/platform-feature-flags": "^0.3.0",
-		"@atlaskit/primitives": "^13.0.0",
-		"@atlaskit/side-navigation": "^3.5.0",
+		"@atlaskit/primitives": "^13.1.0",
+		"@atlaskit/side-navigation": "^3.6.0",
 		"@atlaskit/spinner": "^16.3.0",
 		"@atlaskit/textfield": "^6.5.0",
 		"@atlaskit/theme": "^14.0.0",
-		"@atlaskit/tokens": "^2.1.0",
+		"@atlaskit/tokens": "^2.2.0",
 		"@atlaskit/ufo": "^0.3.0",
 		"@babel/runtime": "^7.0.0",
 		"@kenjiuno/msgreader": "^1.2.6",
@@ -79,7 +79,7 @@
 		"@atlaskit/media-integration-test-helpers": "^3.1.0",
 		"@atlaskit/media-state": "^1.1.0",
 		"@atlaskit/media-test-data": "^2.6.0",
-		"@atlaskit/media-test-helpers": "^34.5.0",
+		"@atlaskit/media-test-helpers": "^34.6.0",
 		"@atlaskit/ssr": "*",
 		"@atlaskit/toggle": "13.4.7",
 		"@atlaskit/visual-regression": "*",