@atlaskit/media-client 35.7.1 → 35.8.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.
@@ -49,7 +49,8 @@ export var mapMediaFileToFileState = function mapMediaFileToFileState(mediaFile)
49
49
  metadataTraceContext = _mediaFile$data.metadataTraceContext,
50
50
  hash = _mediaFile$data.hash,
51
51
  abuseClassification = _mediaFile$data.abuseClassification,
52
- mediaMetadata = _mediaFile$data.mediaMetadata;
52
+ mediaMetadata = _mediaFile$data.mediaMetadata,
53
+ failReason = _mediaFile$data.failReason;
53
54
  var baseState = {
54
55
  id: id,
55
56
  name: name,
@@ -76,7 +77,8 @@ export var mapMediaFileToFileState = function mapMediaFileToFileState(mediaFile)
76
77
  });
77
78
  case 'failed':
78
79
  return _objectSpread(_objectSpread({}, baseState), {}, {
79
- status: 'failed-processing'
80
+ status: 'failed-processing',
81
+ failReason: failReason
80
82
  });
81
83
  }
82
84
  };
@@ -22,13 +22,15 @@ export var getAttrsFromUrl = function getAttrsFromUrl(blobUrl) {
22
22
  var params = new URLSearchParams(hash);
23
23
  var id = params.get('id');
24
24
  var contextId = params.get('contextId');
25
- // check if we have the required params
25
+ var clientId = params.get('clientId');
26
+ // check if we have the required params (clientId is optional for backwards compatibility)
26
27
  if (!id || !contextId) {
27
28
  return;
28
29
  }
29
30
  return {
30
31
  id: id,
31
32
  contextId: contextId,
33
+ clientId: clientId || undefined,
32
34
  collection: getStringFromParams(params, 'collection'),
33
35
  alt: getStringFromParams(params, 'alt'),
34
36
  height: getNumberFromParams(params, 'height'),
@@ -16,6 +16,7 @@ export interface CopySourceFile {
16
16
  id: string;
17
17
  collection?: string;
18
18
  authProvider?: AuthProvider;
19
+ clientId?: string;
19
20
  }
20
21
  export interface CopyDestination extends MediaStoreCopyFileWithTokenParams {
21
22
  authProvider?: AuthProvider;
@@ -23,6 +23,7 @@ export declare class MediaClient {
23
23
  getImage(id: string, params?: MediaStoreGetFileImageParams, controller?: AbortController, fetchMaxRes?: boolean, traceContext?: MediaTraceContext): Promise<Blob>;
24
24
  getImageUrl(id: string, params?: MediaStoreGetFileImageParams): Promise<string>;
25
25
  getImageUrlSync(id: string, params?: MediaStoreGetFileImageParams): string;
26
+ getClientId(collectionName?: string): Promise<string | undefined>;
26
27
  getImageMetadata(id: string, params?: MediaStoreGetFileImageParams): Promise<ImageMetadata>;
27
28
  mobileUploadPromise(): Promise<MobileUpload>;
28
29
  removeFileFromCollection(id: string, collectionName: string, occurrenceKey?: string, traceContext?: MediaTraceContext): Promise<void>;
@@ -9,6 +9,7 @@ export declare class MediaStore implements MediaApi {
9
9
  private readonly config;
10
10
  private readonly _chunkHashAlgorithm;
11
11
  constructor(config: MediaApiConfig);
12
+ getClientId(collectionName?: string): Promise<string | undefined>;
12
13
  removeCollectionFile(id: string, collectionName: string, occurrenceKey?: string, traceContext?: MediaTraceContext): Promise<void>;
13
14
  createUpload(createUpTo?: number, collectionName?: string, traceContext?: MediaTraceContext): Promise<MediaStoreResponse<MediaUpload[]>>;
14
15
  uploadChunk(etag: string, blob: Blob, uploadId: string, partNumber: number, collectionName?: string, traceContext?: MediaTraceContext): Promise<void>;
@@ -34,7 +35,7 @@ export declare class MediaStore implements MediaApi {
34
35
  getDocumentPageImage(id: string, options: GetDocumentPageImage, traceContext?: MediaTraceContext): Promise<Blob>;
35
36
  appendChunksToUpload(uploadId: string, body: AppendChunksToUploadRequestBody, collectionName?: string, traceContext?: MediaTraceContext): Promise<void>;
36
37
  copyFileWithToken(body: MediaStoreCopyFileWithTokenBody, params: MediaStoreCopyFileWithTokenParams, traceContext?: MediaTraceContext): Promise<MediaStoreResponse<MediaFile>>;
37
- copyFile(id: string, params: CopyFileParams, traceContext?: MediaTraceContext): Promise<MediaStoreResponse<MediaFile>>;
38
+ copyFile(id: string, params: CopyFileParams, traceContext?: MediaTraceContext, clientId?: string): Promise<MediaStoreResponse<MediaFile>>;
38
39
  registerCopyIntents(files: Array<{
39
40
  id: string;
40
41
  collection?: string;
@@ -1,4 +1,5 @@
1
1
  import { type MediaType } from './media';
2
+ import { type ProcessingFailReason } from '@atlaskit/media-state';
2
3
  export type MediaItemType = 'file' | 'external-image';
3
4
  export interface FileItem {
4
5
  type: 'file';
@@ -22,4 +23,5 @@ export interface FileDetails {
22
23
  processingStatus?: FileProcessingStatus;
23
24
  artifacts?: Artifacts;
24
25
  createdAt?: number;
26
+ failReason?: ProcessingFailReason;
25
27
  }
@@ -1,5 +1,5 @@
1
1
  import { type MediaTraceContext, type MediaType } from '@atlaskit/media-common';
2
- import { type MediaFileArtifacts } from '@atlaskit/media-state';
2
+ import { type MediaFileArtifacts, type ProcessingFailReason } from '@atlaskit/media-state';
3
3
  export type MediaFileProcessingStatus = 'pending' | 'succeeded' | 'failed';
4
4
  export type { MediaType } from '@atlaskit/media-common';
5
5
  export declare const isPreviewableType: (type: MediaType) => boolean;
@@ -24,6 +24,7 @@ export type MediaFile = {
24
24
  readonly metadataTraceContext?: MediaTraceContext;
25
25
  readonly abuseClassification?: AbuseClassification;
26
26
  readonly mediaMetadata?: FileMediaMetadata;
27
+ readonly failReason?: ProcessingFailReason;
27
28
  };
28
29
  export type MediaItemDetails = {
29
30
  readonly mediaType: MediaType;
@@ -38,6 +39,7 @@ export type MediaItemDetails = {
38
39
  readonly metadataTraceContext?: MediaTraceContext;
39
40
  readonly abuseClassification?: AbuseClassification;
40
41
  readonly mediaMetadata?: FileMediaMetadata;
42
+ readonly failReason?: ProcessingFailReason;
41
43
  };
42
44
  export type NotFoundMediaItemDetails = {
43
45
  readonly id: string;
@@ -2,6 +2,7 @@ export declare const isMediaBlobUrl: (url: string) => boolean;
2
2
  export interface MediaBlobUrlAttrs {
3
3
  id: string;
4
4
  contextId: string;
5
+ clientId?: string;
5
6
  collection?: string;
6
7
  size?: number;
7
8
  name?: string;
@@ -16,6 +16,7 @@ export interface CopySourceFile {
16
16
  id: string;
17
17
  collection?: string;
18
18
  authProvider?: AuthProvider;
19
+ clientId?: string;
19
20
  }
20
21
  export interface CopyDestination extends MediaStoreCopyFileWithTokenParams {
21
22
  authProvider?: AuthProvider;
@@ -23,6 +23,7 @@ export declare class MediaClient {
23
23
  getImage(id: string, params?: MediaStoreGetFileImageParams, controller?: AbortController, fetchMaxRes?: boolean, traceContext?: MediaTraceContext): Promise<Blob>;
24
24
  getImageUrl(id: string, params?: MediaStoreGetFileImageParams): Promise<string>;
25
25
  getImageUrlSync(id: string, params?: MediaStoreGetFileImageParams): string;
26
+ getClientId(collectionName?: string): Promise<string | undefined>;
26
27
  getImageMetadata(id: string, params?: MediaStoreGetFileImageParams): Promise<ImageMetadata>;
27
28
  mobileUploadPromise(): Promise<MobileUpload>;
28
29
  removeFileFromCollection(id: string, collectionName: string, occurrenceKey?: string, traceContext?: MediaTraceContext): Promise<void>;
@@ -9,6 +9,7 @@ export declare class MediaStore implements MediaApi {
9
9
  private readonly config;
10
10
  private readonly _chunkHashAlgorithm;
11
11
  constructor(config: MediaApiConfig);
12
+ getClientId(collectionName?: string): Promise<string | undefined>;
12
13
  removeCollectionFile(id: string, collectionName: string, occurrenceKey?: string, traceContext?: MediaTraceContext): Promise<void>;
13
14
  createUpload(createUpTo?: number, collectionName?: string, traceContext?: MediaTraceContext): Promise<MediaStoreResponse<MediaUpload[]>>;
14
15
  uploadChunk(etag: string, blob: Blob, uploadId: string, partNumber: number, collectionName?: string, traceContext?: MediaTraceContext): Promise<void>;
@@ -34,7 +35,7 @@ export declare class MediaStore implements MediaApi {
34
35
  getDocumentPageImage(id: string, options: GetDocumentPageImage, traceContext?: MediaTraceContext): Promise<Blob>;
35
36
  appendChunksToUpload(uploadId: string, body: AppendChunksToUploadRequestBody, collectionName?: string, traceContext?: MediaTraceContext): Promise<void>;
36
37
  copyFileWithToken(body: MediaStoreCopyFileWithTokenBody, params: MediaStoreCopyFileWithTokenParams, traceContext?: MediaTraceContext): Promise<MediaStoreResponse<MediaFile>>;
37
- copyFile(id: string, params: CopyFileParams, traceContext?: MediaTraceContext): Promise<MediaStoreResponse<MediaFile>>;
38
+ copyFile(id: string, params: CopyFileParams, traceContext?: MediaTraceContext, clientId?: string): Promise<MediaStoreResponse<MediaFile>>;
38
39
  registerCopyIntents(files: Array<{
39
40
  id: string;
40
41
  collection?: string;
@@ -1,4 +1,5 @@
1
1
  import { type MediaType } from './media';
2
+ import { type ProcessingFailReason } from '@atlaskit/media-state';
2
3
  export type MediaItemType = 'file' | 'external-image';
3
4
  export interface FileItem {
4
5
  type: 'file';
@@ -22,4 +23,5 @@ export interface FileDetails {
22
23
  processingStatus?: FileProcessingStatus;
23
24
  artifacts?: Artifacts;
24
25
  createdAt?: number;
26
+ failReason?: ProcessingFailReason;
25
27
  }
@@ -1,5 +1,5 @@
1
1
  import { type MediaTraceContext, type MediaType } from '@atlaskit/media-common';
2
- import { type MediaFileArtifacts } from '@atlaskit/media-state';
2
+ import { type MediaFileArtifacts, type ProcessingFailReason } from '@atlaskit/media-state';
3
3
  export type MediaFileProcessingStatus = 'pending' | 'succeeded' | 'failed';
4
4
  export type { MediaType } from '@atlaskit/media-common';
5
5
  export declare const isPreviewableType: (type: MediaType) => boolean;
@@ -24,6 +24,7 @@ export type MediaFile = {
24
24
  readonly metadataTraceContext?: MediaTraceContext;
25
25
  readonly abuseClassification?: AbuseClassification;
26
26
  readonly mediaMetadata?: FileMediaMetadata;
27
+ readonly failReason?: ProcessingFailReason;
27
28
  };
28
29
  export type MediaItemDetails = {
29
30
  readonly mediaType: MediaType;
@@ -38,6 +39,7 @@ export type MediaItemDetails = {
38
39
  readonly metadataTraceContext?: MediaTraceContext;
39
40
  readonly abuseClassification?: AbuseClassification;
40
41
  readonly mediaMetadata?: FileMediaMetadata;
42
+ readonly failReason?: ProcessingFailReason;
41
43
  };
42
44
  export type NotFoundMediaItemDetails = {
43
45
  readonly id: string;
@@ -2,6 +2,7 @@ export declare const isMediaBlobUrl: (url: string) => boolean;
2
2
  export interface MediaBlobUrlAttrs {
3
3
  id: string;
4
4
  contextId: string;
5
+ clientId?: string;
5
6
  collection?: string;
6
7
  size?: number;
7
8
  name?: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/media-client",
3
- "version": "35.7.1",
3
+ "version": "35.8.0",
4
4
  "description": "Media API Web Client Library",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/"
@@ -31,7 +31,7 @@
31
31
  "dependencies": {
32
32
  "@atlaskit/atlassian-context": "^0.6.0",
33
33
  "@atlaskit/chunkinator": "^7.0.0",
34
- "@atlaskit/media-common": "^12.3.0",
34
+ "@atlaskit/media-common": "^12.4.0",
35
35
  "@atlaskit/platform-feature-flags": "^1.1.0",
36
36
  "@babel/runtime": "^7.0.0",
37
37
  "dataloader": "^2.1.0",
@@ -53,7 +53,8 @@
53
53
  "@atlaskit/media-core": "^37.0.0",
54
54
  "@atlaskit/media-state": "^1.8.0",
55
55
  "@atlaskit/ssr": "workspace:^",
56
- "@atlaskit/tokens": "^9.0.0",
56
+ "@atlaskit/tokens": "^11.0.0",
57
+ "@atlassian/a11y-jest-testing": "^0.10.0",
57
58
  "@atlassian/feature-flags-test-utils": "^1.0.0",
58
59
  "@emotion/react": "^11.7.1",
59
60
  "@types/deep-equal": "^1.0.1",