@atlaskit/media-client 33.1.1 → 33.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/esm/index.js CHANGED
@@ -3,7 +3,7 @@ export { UploadController } from './upload-controller';
3
3
  export { isPreviewableType } from './models/media';
4
4
  export { getArtifactUrl } from './models/artifacts';
5
5
  export { isMediaClientError, getMediaClientErrorReason, isCommonMediaClientError, toCommonMediaClientError } from './models/errors';
6
- export { isUploadingFileState, isProcessingFileState, isProcessedFileState, isErrorFileState, isPreviewableFileState, isFinalFileState, isImageRepresentationReady, isNonErrorFinalFileState, mapMediaFileToFileState, mapMediaItemToFileState } from './models/file-state';
6
+ export { isUploadingFileState, isProcessingFileState, isProcessedFileState, isErrorFileState, isPreviewableFileState, isFinalFileState, isImageRepresentationReady, isNonErrorFinalFileState, mapMediaFileToFileState, mapMediaItemToFileState, hasArtifacts } from './models/file-state';
7
7
  export { uploadFile } from './uploader';
8
8
  export { request, RequestError, isRequestError, isRateLimitedError, createRequestErrorReason } from './utils/request';
9
9
  export { isAbortedRequestError, createUrl } from './utils/request/helpers';
@@ -22,6 +22,9 @@ export var isFinalFileState = function isFinalFileState(fileState) {
22
22
  export var isNonErrorFinalFileState = function isNonErrorFinalFileState(fileState) {
23
23
  return ['processed', 'failed-processing'].includes(fileState.status);
24
24
  };
25
+ export var hasArtifacts = function hasArtifacts(fileState) {
26
+ return 'artifacts' in fileState && fileState.artifacts !== undefined;
27
+ };
25
28
  export var isImageRepresentationReady = function isImageRepresentationReady(fileState) {
26
29
  switch (fileState.status) {
27
30
  case 'processing':
@@ -42,6 +42,13 @@ export interface FileFetcher {
42
42
  getFileBinaryURL(id: string, collectionName?: string, maxAge?: number): Promise<string>;
43
43
  registerCopyIntent(id: string, collectionName?: string): Promise<void>;
44
44
  uploadArtifact(id: string, file: File, params: UploadArtifactParams, collectionName?: string, traceContext?: MediaTraceContext): Promise<MediaItemDetails>;
45
+ /** @exprimental This is exprimental for the purposes of COMMIT-18082 and is prone to breaking changes */
46
+ getVideoDurations(files: Array<{
47
+ id: string;
48
+ collectionName?: string;
49
+ }>): Promise<{
50
+ [key: string]: number;
51
+ }>;
45
52
  }
46
53
  export declare class FileFetcherImpl implements FileFetcher {
47
54
  private readonly mediaApi;
@@ -67,4 +74,10 @@ export declare class FileFetcherImpl implements FileFetcher {
67
74
  private copyFileWithIntent;
68
75
  copyFile(source: CopySourceFile, destination: CopyDestination, options?: CopyFileOptions, traceContext?: MediaTraceContext): Promise<MediaFile>;
69
76
  uploadArtifact: FileFetcher['uploadArtifact'];
77
+ private getOrFetchFileState;
78
+ private getDurationOfVideo;
79
+ getVideoDurations: (files: Array<{
80
+ id: string;
81
+ collectionName?: string;
82
+ }>) => Promise<Record<string, number>>;
70
83
  }
@@ -8,7 +8,7 @@ export type { MediaFileProcessingStatus, MediaType, MediaFile, MediaRepresentati
8
8
  export { getArtifactUrl } from './models/artifacts';
9
9
  export { isMediaClientError, getMediaClientErrorReason, isCommonMediaClientError, toCommonMediaClientError, } from './models/errors';
10
10
  export type { MediaClientError, MediaClientErrorReason, MediaClientErrorAttributes, } from './models/errors';
11
- export { isUploadingFileState, isProcessingFileState, isProcessedFileState, isErrorFileState, isPreviewableFileState, isFinalFileState, isImageRepresentationReady, isNonErrorFinalFileState, mapMediaFileToFileState, mapMediaItemToFileState, } from './models/file-state';
11
+ export { isUploadingFileState, isProcessingFileState, isProcessedFileState, isErrorFileState, isPreviewableFileState, isFinalFileState, isImageRepresentationReady, isNonErrorFinalFileState, mapMediaFileToFileState, mapMediaItemToFileState, hasArtifacts, } from './models/file-state';
12
12
  export type { FileStatus, PreviewOptions, GetFileOptions, NonErrorFileState, PreviewableFileState, } from './models/file-state';
13
13
  export type { FileState, FilePreview, ErrorFileState, UploadingFileState, ProcessingFileState, ProcessedFileState, ProcessingFailedState, MediaFileArtifact, MediaFileArtifacts, } from '@atlaskit/media-state';
14
14
  export type { MobileUpload, MobileUploadStartEvent, MobileUploadProgressEvent, MobileUploadEndEvent, MobileUploadErrorEvent, } from './models/mobile-upload';
@@ -1,7 +1,7 @@
1
1
  import { type FileStatus as CommonFileStatus } from '@atlaskit/media-common';
2
2
  import { type MediaStoreResponse } from '../client/media-store';
3
3
  import { type MediaItemDetails, type MediaFile } from './media';
4
- import { type FilePreview, type FileState, type ErrorFileState, type UploadingFileState, type ProcessingFileState, type ProcessedFileState, type ProcessingFailedState } from '@atlaskit/media-state';
4
+ import { type FilePreview, type FileState, type ErrorFileState, type UploadingFileState, type ProcessingFileState, type ProcessedFileState, type ProcessingFailedState, type MediaFileArtifacts } from '@atlaskit/media-state';
5
5
  export type FileStatus = CommonFileStatus;
6
6
  export interface PreviewOptions {
7
7
  }
@@ -23,6 +23,9 @@ export declare const isErrorFileState: (fileState: FileState) => fileState is Er
23
23
  export declare const isPreviewableFileState: (fileState: FileState) => fileState is (UploadingFileState | ProcessingFileState | ProcessedFileState | ProcessingFailedState) & PreviewableFileState;
24
24
  export declare const isFinalFileState: (fileState: FileState) => fileState is ProcessedFileState | ErrorFileState | ProcessingFailedState;
25
25
  export declare const isNonErrorFinalFileState: (fileState: FileState) => fileState is ProcessedFileState | ProcessingFailedState;
26
+ export declare const hasArtifacts: (fileState: FileState) => fileState is FileState & {
27
+ artifacts: MediaFileArtifacts;
28
+ };
26
29
  export declare const isImageRepresentationReady: (fileState: FileState) => boolean;
27
30
  export declare const mapMediaFileToFileState: (mediaFile: MediaStoreResponse<MediaFile>) => FileState;
28
31
  export declare const mapMediaItemToFileState: (id: string, item: MediaItemDetails) => FileState;
@@ -42,6 +42,13 @@ export interface FileFetcher {
42
42
  getFileBinaryURL(id: string, collectionName?: string, maxAge?: number): Promise<string>;
43
43
  registerCopyIntent(id: string, collectionName?: string): Promise<void>;
44
44
  uploadArtifact(id: string, file: File, params: UploadArtifactParams, collectionName?: string, traceContext?: MediaTraceContext): Promise<MediaItemDetails>;
45
+ /** @exprimental This is exprimental for the purposes of COMMIT-18082 and is prone to breaking changes */
46
+ getVideoDurations(files: Array<{
47
+ id: string;
48
+ collectionName?: string;
49
+ }>): Promise<{
50
+ [key: string]: number;
51
+ }>;
45
52
  }
46
53
  export declare class FileFetcherImpl implements FileFetcher {
47
54
  private readonly mediaApi;
@@ -67,4 +74,10 @@ export declare class FileFetcherImpl implements FileFetcher {
67
74
  private copyFileWithIntent;
68
75
  copyFile(source: CopySourceFile, destination: CopyDestination, options?: CopyFileOptions, traceContext?: MediaTraceContext): Promise<MediaFile>;
69
76
  uploadArtifact: FileFetcher['uploadArtifact'];
77
+ private getOrFetchFileState;
78
+ private getDurationOfVideo;
79
+ getVideoDurations: (files: Array<{
80
+ id: string;
81
+ collectionName?: string;
82
+ }>) => Promise<Record<string, number>>;
70
83
  }
@@ -8,7 +8,7 @@ export type { MediaFileProcessingStatus, MediaType, MediaFile, MediaRepresentati
8
8
  export { getArtifactUrl } from './models/artifacts';
9
9
  export { isMediaClientError, getMediaClientErrorReason, isCommonMediaClientError, toCommonMediaClientError, } from './models/errors';
10
10
  export type { MediaClientError, MediaClientErrorReason, MediaClientErrorAttributes, } from './models/errors';
11
- export { isUploadingFileState, isProcessingFileState, isProcessedFileState, isErrorFileState, isPreviewableFileState, isFinalFileState, isImageRepresentationReady, isNonErrorFinalFileState, mapMediaFileToFileState, mapMediaItemToFileState, } from './models/file-state';
11
+ export { isUploadingFileState, isProcessingFileState, isProcessedFileState, isErrorFileState, isPreviewableFileState, isFinalFileState, isImageRepresentationReady, isNonErrorFinalFileState, mapMediaFileToFileState, mapMediaItemToFileState, hasArtifacts, } from './models/file-state';
12
12
  export type { FileStatus, PreviewOptions, GetFileOptions, NonErrorFileState, PreviewableFileState, } from './models/file-state';
13
13
  export type { FileState, FilePreview, ErrorFileState, UploadingFileState, ProcessingFileState, ProcessedFileState, ProcessingFailedState, MediaFileArtifact, MediaFileArtifacts, } from '@atlaskit/media-state';
14
14
  export type { MobileUpload, MobileUploadStartEvent, MobileUploadProgressEvent, MobileUploadEndEvent, MobileUploadErrorEvent, } from './models/mobile-upload';
@@ -1,7 +1,7 @@
1
1
  import { type FileStatus as CommonFileStatus } from '@atlaskit/media-common';
2
2
  import { type MediaStoreResponse } from '../client/media-store';
3
3
  import { type MediaItemDetails, type MediaFile } from './media';
4
- import { type FilePreview, type FileState, type ErrorFileState, type UploadingFileState, type ProcessingFileState, type ProcessedFileState, type ProcessingFailedState } from '@atlaskit/media-state';
4
+ import { type FilePreview, type FileState, type ErrorFileState, type UploadingFileState, type ProcessingFileState, type ProcessedFileState, type ProcessingFailedState, type MediaFileArtifacts } from '@atlaskit/media-state';
5
5
  export type FileStatus = CommonFileStatus;
6
6
  export interface PreviewOptions {
7
7
  }
@@ -23,6 +23,9 @@ export declare const isErrorFileState: (fileState: FileState) => fileState is Er
23
23
  export declare const isPreviewableFileState: (fileState: FileState) => fileState is (UploadingFileState | ProcessingFileState | ProcessedFileState | ProcessingFailedState) & PreviewableFileState;
24
24
  export declare const isFinalFileState: (fileState: FileState) => fileState is ProcessedFileState | ErrorFileState | ProcessingFailedState;
25
25
  export declare const isNonErrorFinalFileState: (fileState: FileState) => fileState is ProcessedFileState | ProcessingFailedState;
26
+ export declare const hasArtifacts: (fileState: FileState) => fileState is FileState & {
27
+ artifacts: MediaFileArtifacts;
28
+ };
26
29
  export declare const isImageRepresentationReady: (fileState: FileState) => boolean;
27
30
  export declare const mapMediaFileToFileState: (mediaFile: MediaStoreResponse<MediaFile>) => FileState;
28
31
  export declare const mapMediaItemToFileState: (id: string, item: MediaItemDetails) => FileState;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/media-client",
3
- "version": "33.1.1",
3
+ "version": "33.3.0",
4
4
  "description": "Media API Web Client Library",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/"
@@ -51,11 +51,11 @@
51
51
  },
52
52
  "peerDependencies": {
53
53
  "@atlaskit/media-core": "^36.1.0",
54
- "@atlaskit/media-state": "^1.5.0"
54
+ "@atlaskit/media-state": "^1.6.0"
55
55
  },
56
56
  "devDependencies": {
57
57
  "@atlaskit/media-core": "^36.1.0",
58
- "@atlaskit/media-state": "^1.5.0",
58
+ "@atlaskit/media-state": "^1.6.0",
59
59
  "@atlaskit/ssr": "workspace:^",
60
60
  "@atlaskit/tokens": "^4.8.0",
61
61
  "@atlassian/feature-flags-test-utils": "^0.3.0",