@atlaskit/media-client 28.0.7 → 28.1.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/CHANGELOG.md +16 -0
- package/dist/cjs/client/file-fetcher/error.js +11 -3
- package/dist/cjs/client/file-fetcher/index.js +29 -11
- package/dist/cjs/client/media-store/MediaStore.js +1 -1
- package/dist/cjs/models/artifacts.js +1 -1
- package/dist/cjs/models/media.js +4 -1
- package/dist/cjs/utils/createFileDataLoader.js +43 -10
- package/dist/cjs/utils/mediaCdn.js +1 -1
- package/dist/cjs/utils/mobileUpload/error.js +6 -2
- package/dist/cjs/utils/mobileUpload/helpers.js +6 -3
- package/dist/cjs/utils/request/errors.js +4 -0
- package/dist/es2019/client/file-fetcher/error.js +8 -2
- package/dist/es2019/client/file-fetcher/index.js +42 -17
- package/dist/es2019/client/media-store/MediaStore.js +1 -1
- package/dist/es2019/models/artifacts.js +1 -1
- package/dist/es2019/models/media.js +3 -0
- package/dist/es2019/utils/createFileDataLoader.js +34 -5
- package/dist/es2019/utils/mediaCdn.js +1 -1
- package/dist/es2019/utils/mobileUpload/error.js +6 -2
- package/dist/es2019/utils/mobileUpload/helpers.js +6 -3
- package/dist/es2019/utils/request/errors.js +5 -1
- package/dist/esm/client/file-fetcher/error.js +11 -3
- package/dist/esm/client/file-fetcher/index.js +30 -12
- package/dist/esm/client/media-store/MediaStore.js +1 -1
- package/dist/esm/models/artifacts.js +1 -1
- package/dist/esm/models/media.js +3 -0
- package/dist/esm/utils/createFileDataLoader.js +43 -10
- package/dist/esm/utils/mediaCdn.js +1 -1
- package/dist/esm/utils/mobileUpload/error.js +6 -2
- package/dist/esm/utils/mobileUpload/helpers.js +6 -3
- package/dist/esm/utils/request/errors.js +4 -0
- package/dist/types/client/file-fetcher/error.d.ts +7 -0
- package/dist/types/client/media-store/index.d.ts +1 -1
- package/dist/types/client/media-store/types.d.ts +6 -0
- package/dist/types/index.d.ts +1 -1
- package/dist/types/models/media.d.ts +7 -0
- package/dist/types/utils/createFileDataLoader.d.ts +4 -4
- package/dist/types/utils/mobileUpload/error.d.ts +7 -0
- package/dist/types/utils/request/errors.d.ts +3 -0
- package/dist/types-ts4.5/client/file-fetcher/error.d.ts +7 -0
- package/dist/types-ts4.5/client/media-store/index.d.ts +1 -1
- package/dist/types-ts4.5/client/media-store/types.d.ts +6 -0
- package/dist/types-ts4.5/index.d.ts +1 -1
- package/dist/types-ts4.5/models/media.d.ts +7 -0
- package/dist/types-ts4.5/utils/createFileDataLoader.d.ts +4 -4
- package/dist/types-ts4.5/utils/mobileUpload/error.d.ts +7 -0
- package/dist/types-ts4.5/utils/request/errors.d.ts +3 -0
- package/package.json +2 -8
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { BaseMediaClientError } from '../../models/errors';
|
|
2
|
+
import { type MediaTraceContext } from '@atlaskit/media-common';
|
|
2
3
|
export type FileFetcherErrorReason = 'invalidFileId' | 'emptyItems' | 'zeroVersionFile' | 'emptyFileName';
|
|
3
4
|
export type FileFetcherErrorAttributes = {
|
|
4
5
|
readonly reason: FileFetcherErrorReason;
|
|
@@ -6,6 +7,7 @@ export type FileFetcherErrorAttributes = {
|
|
|
6
7
|
readonly metadata?: {
|
|
7
8
|
readonly collectionName?: string;
|
|
8
9
|
readonly occurrenceKey?: string;
|
|
10
|
+
readonly traceContext?: MediaTraceContext;
|
|
9
11
|
};
|
|
10
12
|
};
|
|
11
13
|
export declare class FileFetcherError extends BaseMediaClientError<FileFetcherErrorAttributes> {
|
|
@@ -14,12 +16,17 @@ export declare class FileFetcherError extends BaseMediaClientError<FileFetcherEr
|
|
|
14
16
|
readonly metadata?: {
|
|
15
17
|
readonly collectionName?: string | undefined;
|
|
16
18
|
readonly occurrenceKey?: string | undefined;
|
|
19
|
+
readonly traceContext?: MediaTraceContext | undefined;
|
|
17
20
|
} | undefined;
|
|
18
21
|
constructor(reason: FileFetcherErrorReason, id: string, metadata?: {
|
|
19
22
|
readonly collectionName?: string | undefined;
|
|
20
23
|
readonly occurrenceKey?: string | undefined;
|
|
24
|
+
readonly traceContext?: MediaTraceContext | undefined;
|
|
21
25
|
} | undefined);
|
|
22
26
|
get attributes(): {
|
|
27
|
+
metadata?: {
|
|
28
|
+
traceContext: MediaTraceContext;
|
|
29
|
+
} | undefined;
|
|
23
30
|
reason: FileFetcherErrorReason;
|
|
24
31
|
id: string;
|
|
25
32
|
collectionName: string | undefined;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
export type { MediaStoreErrorReason, MediaStoreErrorAttributes } from './error';
|
|
2
2
|
export { MediaStoreError, isMediaStoreError } from './error';
|
|
3
3
|
export { MediaStore, getMediaEnvironment, getMediaRegion } from './MediaStore';
|
|
4
|
-
export type { ResponseFileItem, ItemsPayload, ImageMetadataArtifact, ImageMetadata, MediaStoreResponse, MediaStoreRequestOptions, MediaStoreCreateFileFromUploadParams, MediaStoreCreateFileParams, MediaStoreTouchFileParams, TouchFileDescriptor, MediaStoreTouchFileBody, MediaStoreCreateFileFromBinaryParams, MediaStoreCreateFileFromUploadConditions, MediaStoreCreateFileFromUploadBody, MediaStoreGetFileParams, MediaStoreGetFileImageParams, SourceFile, MediaStoreCopyFileWithTokenBody, MediaStoreCopyFileWithTokenParams, AppendChunksToUploadRequestBody, CreatedTouchedFile, RejectedTouchFile, RejectionError, TouchedFiles, EmptyFile, MediaApi, } from './types';
|
|
4
|
+
export type { ResponseFileItem, EmptyResponseFileItem, ItemsPayload, ImageMetadataArtifact, ImageMetadata, MediaStoreResponse, MediaStoreRequestOptions, MediaStoreCreateFileFromUploadParams, MediaStoreCreateFileParams, MediaStoreTouchFileParams, TouchFileDescriptor, MediaStoreTouchFileBody, MediaStoreCreateFileFromBinaryParams, MediaStoreCreateFileFromUploadConditions, MediaStoreCreateFileFromUploadBody, MediaStoreGetFileParams, MediaStoreGetFileImageParams, SourceFile, MediaStoreCopyFileWithTokenBody, MediaStoreCopyFileWithTokenParams, AppendChunksToUploadRequestBody, CreatedTouchedFile, RejectedTouchFile, RejectionError, TouchedFiles, EmptyFile, MediaApi, } from './types';
|
|
@@ -11,6 +11,12 @@ export interface ResponseFileItem {
|
|
|
11
11
|
collection?: string;
|
|
12
12
|
metadataTraceContext?: MediaTraceContext;
|
|
13
13
|
}
|
|
14
|
+
export interface EmptyResponseFileItem {
|
|
15
|
+
id: string;
|
|
16
|
+
type: 'not-found';
|
|
17
|
+
collection?: string;
|
|
18
|
+
metadataTraceContext?: MediaTraceContext;
|
|
19
|
+
}
|
|
14
20
|
export interface ItemsPayload {
|
|
15
21
|
items: ResponseFileItem[];
|
|
16
22
|
}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
export { MediaStore, MediaStoreError, isMediaStoreError, getMediaEnvironment, getMediaRegion, } from './client/media-store';
|
|
2
|
-
export type { ResponseFileItem, ItemsPayload, ImageMetadataArtifact, ImageMetadata, MediaStoreResponse, MediaStoreRequestOptions, MediaStoreCreateFileFromUploadParams, MediaStoreCreateFileParams, MediaStoreTouchFileParams, TouchFileDescriptor, MediaStoreTouchFileBody, MediaStoreCreateFileFromBinaryParams, MediaStoreCreateFileFromUploadConditions, MediaStoreCreateFileFromUploadBody, MediaStoreGetFileParams, MediaStoreGetFileImageParams, SourceFile, MediaStoreCopyFileWithTokenBody, MediaStoreCopyFileWithTokenParams, AppendChunksToUploadRequestBody, CreatedTouchedFile, TouchedFiles, EmptyFile, MediaStoreErrorReason, MediaStoreErrorAttributes, MediaApi, } from './client/media-store';
|
|
2
|
+
export type { ResponseFileItem, EmptyResponseFileItem, ItemsPayload, ImageMetadataArtifact, ImageMetadata, MediaStoreResponse, MediaStoreRequestOptions, MediaStoreCreateFileFromUploadParams, MediaStoreCreateFileParams, MediaStoreTouchFileParams, TouchFileDescriptor, MediaStoreTouchFileBody, MediaStoreCreateFileFromBinaryParams, MediaStoreCreateFileFromUploadConditions, MediaStoreCreateFileFromUploadBody, MediaStoreGetFileParams, MediaStoreGetFileImageParams, SourceFile, MediaStoreCopyFileWithTokenBody, MediaStoreCopyFileWithTokenParams, AppendChunksToUploadRequestBody, CreatedTouchedFile, TouchedFiles, EmptyFile, MediaStoreErrorReason, MediaStoreErrorAttributes, MediaApi, } from './client/media-store';
|
|
3
3
|
export { UploadController } from './upload-controller';
|
|
4
4
|
export type { AbortFunction } from './upload-controller';
|
|
5
5
|
export type { MediaItemType, FileItem, FileProcessingStatus, MediaArtifact, Artifacts, FileDetails, } from './models/item';
|
|
@@ -26,6 +26,13 @@ export type MediaItemDetails = {
|
|
|
26
26
|
readonly createdAt?: number;
|
|
27
27
|
readonly metadataTraceContext?: MediaTraceContext;
|
|
28
28
|
};
|
|
29
|
+
export type NotFoundMediaItemDetails = {
|
|
30
|
+
readonly id: string;
|
|
31
|
+
readonly collection?: string;
|
|
32
|
+
readonly type: 'not-found';
|
|
33
|
+
readonly metadataTraceContext?: MediaTraceContext;
|
|
34
|
+
};
|
|
35
|
+
export declare const isNotFoundMediaItemDetails: (itemDetails: any) => itemDetails is NotFoundMediaItemDetails;
|
|
29
36
|
export type MediaRepresentations = {
|
|
30
37
|
image?: Object;
|
|
31
38
|
};
|
|
@@ -1,18 +1,18 @@
|
|
|
1
1
|
import Dataloader from 'dataloader';
|
|
2
|
-
import { type MediaStore, type ResponseFileItem } from '../client/media-store';
|
|
3
|
-
import { type MediaItemDetails } from '../models/media';
|
|
2
|
+
import { type MediaStore, type ResponseFileItem, type EmptyResponseFileItem } from '../client/media-store';
|
|
3
|
+
import { type NotFoundMediaItemDetails, type MediaItemDetails } from '../models/media';
|
|
4
4
|
export declare const MAX_BATCH_SIZE = 100;
|
|
5
5
|
export type DataloaderKey = {
|
|
6
6
|
readonly id: string;
|
|
7
7
|
readonly collectionName?: string;
|
|
8
8
|
};
|
|
9
|
-
export type DataloaderResult = MediaItemDetails |
|
|
9
|
+
export type DataloaderResult = MediaItemDetails | NotFoundMediaItemDetails;
|
|
10
10
|
export type BatchLoadingErrorResult = {
|
|
11
11
|
readonly id: string;
|
|
12
12
|
readonly collection?: string;
|
|
13
13
|
readonly error: Error;
|
|
14
14
|
};
|
|
15
|
-
export declare const getItemsFromKeys: (dataloaderKeys: ReadonlyArray<DataloaderKey>, fileItems: Array<ResponseFileItem | BatchLoadingErrorResult>) => Array<DataloaderResult | Error>;
|
|
15
|
+
export declare const getItemsFromKeys: (dataloaderKeys: ReadonlyArray<DataloaderKey>, fileItems: Array<ResponseFileItem | BatchLoadingErrorResult | EmptyResponseFileItem>) => Array<DataloaderResult | Error>;
|
|
16
16
|
export type FileIdsByCollection = {
|
|
17
17
|
[collectionName: string]: string[];
|
|
18
18
|
};
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { type MediaTraceContext } from '@atlaskit/media-common';
|
|
1
2
|
import { BaseMediaClientError } from '../../models/errors';
|
|
2
3
|
export type MobileUploadErrorReason = 'emptyItems' | 'zeroVersionFile';
|
|
3
4
|
export type MobileUploadErrorAttributes = {
|
|
@@ -6,6 +7,7 @@ export type MobileUploadErrorAttributes = {
|
|
|
6
7
|
readonly metadata?: {
|
|
7
8
|
readonly collectionName?: string;
|
|
8
9
|
readonly occurrenceKey?: string;
|
|
10
|
+
readonly traceContext?: MediaTraceContext;
|
|
9
11
|
};
|
|
10
12
|
};
|
|
11
13
|
export declare class MobileUploadError extends BaseMediaClientError<MobileUploadErrorAttributes> {
|
|
@@ -14,16 +16,21 @@ export declare class MobileUploadError extends BaseMediaClientError<MobileUpload
|
|
|
14
16
|
readonly metadata?: {
|
|
15
17
|
readonly collectionName?: string | undefined;
|
|
16
18
|
readonly occurrenceKey?: string | undefined;
|
|
19
|
+
readonly traceContext?: MediaTraceContext | undefined;
|
|
17
20
|
} | undefined;
|
|
18
21
|
constructor(reason: MobileUploadErrorReason, id: string, metadata?: {
|
|
19
22
|
readonly collectionName?: string | undefined;
|
|
20
23
|
readonly occurrenceKey?: string | undefined;
|
|
24
|
+
readonly traceContext?: MediaTraceContext | undefined;
|
|
21
25
|
} | undefined);
|
|
22
26
|
get attributes(): {
|
|
23
27
|
reason: MobileUploadErrorReason;
|
|
24
28
|
id: string;
|
|
25
29
|
collectionName: string | undefined;
|
|
26
30
|
occurrenceKey: string | undefined;
|
|
31
|
+
metadata: {
|
|
32
|
+
traceContext: MediaTraceContext | undefined;
|
|
33
|
+
};
|
|
27
34
|
};
|
|
28
35
|
}
|
|
29
36
|
export declare function isMobileUploadError(err: Error): err is MobileUploadError;
|
|
@@ -14,6 +14,9 @@ export declare class RequestError extends BaseMediaClientError<RequestErrorAttri
|
|
|
14
14
|
attempts: number | undefined;
|
|
15
15
|
clientExhaustedRetries: boolean | undefined;
|
|
16
16
|
statusCode: number | undefined;
|
|
17
|
+
metadata: {
|
|
18
|
+
traceContext: import("@atlaskit/media-common").MediaTraceContext | undefined;
|
|
19
|
+
};
|
|
17
20
|
innerError: Error | undefined;
|
|
18
21
|
};
|
|
19
22
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@atlaskit/media-client",
|
|
3
|
-
"version": "28.0
|
|
3
|
+
"version": "28.1.0",
|
|
4
4
|
"description": "Media API Web Client Library",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"registry": "https://registry.npmjs.org/"
|
|
@@ -57,7 +57,7 @@
|
|
|
57
57
|
"@atlaskit/media-core": "^34.3.0",
|
|
58
58
|
"@atlaskit/media-state": "^1.1.0",
|
|
59
59
|
"@atlaskit/ssr": "*",
|
|
60
|
-
"@atlaskit/tokens": "^2.
|
|
60
|
+
"@atlaskit/tokens": "^2.2.0",
|
|
61
61
|
"@atlassian/feature-flags-test-utils": "0.2.3",
|
|
62
62
|
"@emotion/react": "^11.7.1",
|
|
63
63
|
"@types/deep-equal": "^1.0.1",
|
|
@@ -81,15 +81,9 @@
|
|
|
81
81
|
}
|
|
82
82
|
},
|
|
83
83
|
"platform-feature-flags": {
|
|
84
|
-
"platform.media-cdn-delivery": {
|
|
85
|
-
"type": "boolean"
|
|
86
|
-
},
|
|
87
84
|
"platform.media-card-performance-observer_a803k": {
|
|
88
85
|
"type": "boolean"
|
|
89
86
|
},
|
|
90
|
-
"platform.media-cdn-single-host": {
|
|
91
|
-
"type": "boolean"
|
|
92
|
-
},
|
|
93
87
|
"platform_media_cdn_single_host": {
|
|
94
88
|
"type": "boolean"
|
|
95
89
|
},
|