@atlaskit/media-client 18.1.0 → 19.1.0

package/report.api.md

@@ -1,12 +1,17 @@
+<!-- API Report Version: 2.3 -->
+
 ## API Report File for "@atlaskit/media-client"
 
-> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+> Do not edit this file. This report is auto-generated using [API Extractor](https://api-extractor.com/).
+> [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
+
+### Table of contents
 
-<!--
-	Generated API Report version: 2.0
--->
+- [Main Entry Types](#main-entry-types)
 
-[Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
+### Main Entry Types
+
+<!--SECTION START: Main Entry Types-->
 
 ```ts
 import { AsapBasedAuth } from '@atlaskit/media-core';
@@ -19,6 +24,7 @@ import { FileStatus as FileStatus_2 } from '@atlaskit/media-common';
 import { MediaApiConfig } from '@atlaskit/media-core';
 import { MediaClientConfig } from '@atlaskit/media-core';
 import { MediaFeatureFlags } from '@atlaskit/media-common';
+import { MediaTraceContext } from '@atlaskit/media-common';
 import { MediaType } from '@atlaskit/media-common';
 import { default as React_2 } from 'react';
 import { ReplaySubject } from 'rxjs/ReplaySubject';
@@ -44,12 +50,18 @@ export type Artifacts = {
   [name: string]: MediaArtifact;
 };
 
+// @public (undocumented)
+type BaseFileState = {
+  metadataTraceContext?: MediaTraceContext;
+};
+
 // @public
 abstract class BaseMediaClientError<
-    Attributes extends MediaClientErrorAttributes
+    Attributes extends MediaClientErrorAttributes,
   >
   extends Error
-  implements MediaClientError<Attributes> {
+  implements MediaClientError<Attributes>
+{
   constructor(message: string);
   // (undocumented)
   abstract get attributes(): Attributes;
@@ -73,11 +85,13 @@ export class CollectionFetcher {
   getItems(
     collectionName: string,
     params?: MediaStoreGetCollectionItemsParams,
+    traceContext?: MediaTraceContext,
   ): MediaSubscribable<MediaCollectionItem[]>;
   // (undocumented)
   loadNextPage(
     collectionName: string,
     params?: MediaStoreGetCollectionItemsParams,
+    traceContext?: MediaTraceContext,
   ): Promise<void>;
   // (undocumented)
   readonly mediaStore: MediaStore;
@@ -86,6 +100,7 @@ export class CollectionFetcher {
     id: string,
     collectionName: string,
     occurrenceKey?: string,
+    traceContext?: MediaTraceContext,
   ): Promise<void>;
 }
 
@@ -129,12 +144,12 @@ export interface CreatedTouchedFile {
 
 // @public (undocumented)
 export function createMediaSubject<T extends MediaSubscribableItem>(
-  initialState?: T | Error,
+  initialState?: Error | T,
 ): ReplaySubject<T>;
 
 // @public (undocumented)
 export function createMediaSubscribable<T extends MediaSubscribableItem>(
-  mediaSubscribableItem?: T | Error,
+  mediaSubscribableItem?: Error | T,
 ): MediaSubscribable<T>;
 
 // @public (undocumented)
@@ -176,7 +191,7 @@ export interface EmptyFile {
 }
 
 // @public (undocumented)
-export interface ErrorFileState {
+export interface ErrorFileState extends BaseFileState {
   // (undocumented)
   id: string;
   // (undocumented)
@@ -195,7 +210,7 @@ type ErrorObserver<T> = PartialObserver<T> &
 export type EventPayloadListener<
   M extends EventPayloadMap<P>,
   E extends keyof M,
-  P = any
+  P = any,
 > = (payload: M[E]) => void;
 
 // @public (undocumented)
@@ -251,6 +266,7 @@ export interface FileFetcher {
     source: CopySourceFile,
     destination: CopyDestination,
     options?: CopyFileOptions,
+    traceContext?: MediaTraceContext,
   ): Promise<MediaFile>;
   // (undocumented)
   downloadBinary(
@@ -277,33 +293,34 @@ export interface FileFetcher {
   touchFiles(
     descriptors: TouchFileDescriptor[],
     collection?: string,
+    traceContext?: MediaTraceContext,
   ): Promise<TouchedFiles>;
   // (undocumented)
   upload(
     file: UploadableFile,
     controller?: UploadController,
     uploadableFileUpfrontIds?: UploadableFileUpfrontIds,
+    traceContext?: MediaTraceContext,
   ): MediaSubscribable<FileState>;
   // (undocumented)
   uploadExternal(
     url: string,
     collection?: string,
+    traceContext?: MediaTraceContext,
   ): Promise<ExternalUploadPayload>;
 }
 
 // @public (undocumented)
-export class FileFetcherError extends BaseMediaClientError<
-  FileFetcherErrorAttributes
-> {
+export class FileFetcherError extends BaseMediaClientError<FileFetcherErrorAttributes> {
   constructor(
     reason: FileFetcherErrorReason,
     id: string,
     metadata?:
+      | undefined
       | {
           readonly collectionName?: string | undefined;
           readonly occurrenceKey?: string | undefined;
-        }
-      | undefined,
+        },
   );
   // (undocumented)
   get attributes(): {
@@ -316,11 +333,11 @@ export class FileFetcherError extends BaseMediaClientError<
   readonly id: string;
   // (undocumented)
   readonly metadata?:
+    | undefined
     | {
         readonly collectionName?: string | undefined;
         readonly occurrenceKey?: string | undefined;
-      }
-    | undefined;
+      };
   // (undocumented)
   readonly reason: FileFetcherErrorReason;
 }
@@ -337,8 +354,8 @@ export type FileFetcherErrorAttributes = {
 
 // @public (undocumented)
 export type FileFetcherErrorReason =
-  | 'invalidFileId'
   | 'emptyItems'
+  | 'invalidFileId'
   | 'zeroVersionFile';
 
 // @public (undocumented)
@@ -349,6 +366,7 @@ export class FileFetcherImpl implements FileFetcher {
     source: CopySourceFile,
     destination: CopyDestination,
     options?: CopyFileOptions,
+    traceContext?: MediaTraceContext,
   ): Promise<MediaFile>;
   // (undocumented)
   downloadBinary(
@@ -375,17 +393,20 @@ export class FileFetcherImpl implements FileFetcher {
   touchFiles(
     descriptors: TouchFileDescriptor[],
     collection?: string,
+    traceContext?: MediaTraceContext,
   ): Promise<TouchedFiles>;
   // (undocumented)
   upload(
     file: UploadableFile,
     controller?: UploadController,
     uploadableFileUpfrontIds?: UploadableFileUpfrontIds,
+    traceContext?: MediaTraceContext,
   ): MediaSubscribable<FileState>;
   // (undocumented)
   uploadExternal(
     url: string,
     collection?: string,
+    traceContext?: MediaTraceContext,
   ): Promise<ExternalUploadPayload>;
 }
 
@@ -424,18 +445,18 @@ export interface FilePreview {
 
 // @public (undocumented)
 export type FileProcessingStatus =
+  | 'failed'
   | 'pending'
   | 'running'
-  | 'succeeded'
-  | 'failed';
+  | 'succeeded';
 
 // @public (undocumented)
 export type FileState =
-  | UploadingFileState
-  | ProcessingFileState
-  | ProcessedFileState
   | ErrorFileState
-  | ProcessingFailedState;
+  | ProcessedFileState
+  | ProcessingFailedState
+  | ProcessingFileState
+  | UploadingFileState;
 
 // @public (undocumented)
 export type FileStatus = FileStatus_2;
@@ -476,7 +497,7 @@ export const getMediaClient: (
 // @public (undocumented)
 export function getMediaClientErrorReason(
   err: Error,
-): MediaClientErrorReason | 'unknown';
+): 'unknown' | MediaClientErrorReason;
 
 // @public (undocumented)
 export const getMediaEnvironment: () => string | undefined;
@@ -504,7 +525,7 @@ export const globalMediaEventEmitter: {
 };
 
 // @public (undocumented)
-export type Identifier = FileIdentifier | ExternalImageIdentifier;
+export type Identifier = ExternalImageIdentifier | FileIdentifier;
 
 // @public (undocumented)
 export interface ImageMetadata {
@@ -570,7 +591,7 @@ export const isFileIdentifier: (
 // @public (undocumented)
 export const isFinalFileState: (
   fileState: FileState,
-) => fileState is ProcessedFileState | ProcessingFailedState | ErrorFileState;
+) => fileState is ErrorFileState | ProcessedFileState | ProcessingFailedState;
 
 // @public @deprecated (undocumented)
 export const isImageMimeTypeSupportedByBrowser: (mimeType: string) => boolean;
@@ -591,9 +612,7 @@ export const isImageRepresentationReady: (fileState: FileState) => boolean;
 export const isMediaBlobUrl: (url: string) => boolean;
 
 // @public (undocumented)
-export function isMediaClientError(
-  error: any,
-): error is MediaClientError<{
+export function isMediaClientError(error: any): error is MediaClientError<{
   reason: MediaClientErrorReason;
 }>;
 
@@ -618,10 +637,10 @@ export function isPollingError(err?: Error): err is PollingError;
 export const isPreviewableFileState: (
   fileState: FileState,
 ) => fileState is (
-  | UploadingFileState
-  | ProcessingFileState
   | ProcessedFileState
   | ProcessingFailedState
+  | ProcessingFileState
+  | UploadingFileState
 ) &
   PreviewableFileState;
 
@@ -751,6 +770,7 @@ export class MediaClient {
     params?: MediaStoreGetFileImageParams,
     controller?: AbortController,
     fetchMaxRes?: boolean,
+    traceContext?: MediaTraceContext,
   ): Promise<Blob>;
   // (undocumented)
   getImageMetadata(
@@ -799,28 +819,28 @@ export interface MediaClientErrorAttributes {
 
 // @public (undocumented)
 export type MediaClientErrorReason =
-  | 'clientOffline'
+  | 'authProviderTimedOut'
   | 'clientAbortedRequest'
+  | 'clientOffline'
   | 'clientTimeoutRequest'
-  | 'serverInvalidBody'
+  | 'emptyAuth'
+  | 'emptyItems'
+  | 'failedAuthProvider'
+  | 'fileSizeExceedsLimit'
+  | 'invalidFileId'
+  | 'missingInitialAuth'
+  | 'pollingMaxAttemptsExceeded'
+  | 'serverBadGateway'
   | 'serverBadRequest'
-  | 'serverUnauthorized'
   | 'serverForbidden'
+  | 'serverInternalError'
+  | 'serverInvalidBody'
   | 'serverNotFound'
   | 'serverRateLimited'
-  | 'serverInternalError'
-  | 'serverBadGateway'
+  | 'serverUnauthorized'
   | 'serverUnexpectedError'
-  | 'failedAuthProvider'
   | 'tokenExpired'
-  | 'missingInitialAuth'
-  | 'emptyAuth'
-  | 'authProviderTimedOut'
-  | 'invalidFileId'
-  | 'emptyItems'
-  | 'zeroVersionFile'
-  | 'pollingMaxAttemptsExceeded'
-  | 'fileSizeExceedsLimit';
+  | 'zeroVersionFile';
 
 // @public (undocumented)
 export type MediaCollection = {
@@ -838,8 +858,8 @@ export type MediaCollectionItem = {
 
 // @public (undocumented)
 export type MediaCollectionItemDetails =
-  | MediaCollectionItemMinimalDetails
-  | MediaCollectionItemFullDetails;
+  | MediaCollectionItemFullDetails
+  | MediaCollectionItemMinimalDetails;
 
 // @public (undocumented)
 export type MediaCollectionItemFullDetails = {
@@ -851,6 +871,7 @@ export type MediaCollectionItemFullDetails = {
   readonly artifacts: MediaFileArtifacts;
   readonly representations: MediaRepresentations;
   readonly createdAt?: number;
+  readonly metadataTraceContext?: MediaTraceContext;
 };
 
 // @public (undocumented)
@@ -876,6 +897,7 @@ export type MediaFile = {
   readonly artifacts: MediaFileArtifacts;
   readonly representations: MediaRepresentations;
   readonly createdAt?: number;
+  readonly metadataTraceContext?: MediaTraceContext;
 };
 
 // @public (undocumented)
@@ -897,17 +919,17 @@ export interface MediaFileArtifacts {
 }
 
 // @public (undocumented)
-export type MediaFileProcessingStatus = 'pending' | 'succeeded' | 'failed';
+export type MediaFileProcessingStatus = 'failed' | 'pending' | 'succeeded';
 
 // @public (undocumented)
-export type MediaItemType = 'file' | 'external-image';
+export type MediaItemType = 'external-image' | 'file';
 
 // @public (undocumented)
 export type MediaObserver<T> =
-  | NextObserver<T>
-  | ErrorObserver<T>
+  | ((value: T) => void)
   | CompletionObserver<T>
-  | ((value: T) => void);
+  | ErrorObserver<T>
+  | NextObserver<T>;
 
 // @public (undocumented)
 export type MediaRepresentations = {
@@ -925,21 +947,25 @@ export class MediaStore {
     uploadId: string,
     body: AppendChunksToUploadRequestBody,
     collectionName?: string,
+    traceContext?: MediaTraceContext,
   ): Promise<void>;
   // (undocumented)
   copyFileWithToken(
     body: MediaStoreCopyFileWithTokenBody,
     params: MediaStoreCopyFileWithTokenParams,
+    traceContext?: MediaTraceContext,
   ): Promise<MediaStoreResponse<MediaFile>>;
   // (undocumented)
   createFileFromUpload(
     body: MediaStoreCreateFileFromUploadBody,
     params?: MediaStoreCreateFileFromUploadParams,
+    traceContext?: MediaTraceContext,
   ): Promise<MediaStoreResponse<MediaFile>>;
   // (undocumented)
   createUpload(
     createUpTo?: number,
     collectionName?: string,
+    traceContext?: MediaTraceContext,
   ): Promise<MediaStoreResponse<MediaUpload[]>>;
   // (undocumented)
   readonly featureFlags?: MediaFeatureFlags | undefined;
@@ -953,11 +979,13 @@ export class MediaStore {
   getCollectionItems(
     collectionName: string,
     params?: MediaStoreGetCollectionItemsParams,
+    traceContext?: MediaTraceContext,
   ): Promise<MediaStoreResponse<MediaCollectionItems>>;
   // (undocumented)
   getFile(
     fileId: string,
     params?: MediaStoreGetFileParams,
+    traceContext?: MediaTraceContext,
   ): Promise<MediaStoreResponse<MediaFile>>;
   // (undocumented)
   getFileBinaryURL(id: string, collectionName?: string): Promise<string>;
@@ -977,11 +1005,13 @@ export class MediaStore {
     params?: MediaStoreGetFileImageParams,
     controller?: AbortController,
     fetchMaxRes?: boolean,
+    traceContext?: MediaTraceContext,
   ): Promise<Blob>;
   // (undocumented)
   getImageMetadata(
     id: string,
     params?: MediaStoreGetFileImageParams,
+    traceContext?: MediaTraceContext,
   ): Promise<{
     metadata: ImageMetadata;
   }>;
@@ -989,6 +1019,7 @@ export class MediaStore {
   getItems(
     ids: string[],
     collectionName?: string,
+    traceContext?: MediaTraceContext,
   ): Promise<MediaStoreResponse<ItemsPayload>>;
   // (undocumented)
   probeChunks(
@@ -1000,12 +1031,14 @@ export class MediaStore {
       collectionName?: string;
       uploadId?: string;
     },
+    traceContext?: MediaTraceContext,
   ): Promise<MediaStoreResponse<MediaChunksProbe>>;
   // (undocumented)
   removeCollectionFile(
     id: string,
     collectionName: string,
     occurrenceKey?: string,
+    traceContext?: MediaTraceContext,
   ): Promise<void>;
   // (undocumented)
   request(
@@ -1021,6 +1054,7 @@ export class MediaStore {
   touchFiles(
     body: MediaStoreTouchFileBody,
     params?: MediaStoreTouchFileParams,
+    traceContext?: MediaTraceContext,
   ): Promise<MediaStoreResponse<TouchedFiles>>;
   // (undocumented)
   uploadChunk(
@@ -1035,6 +1069,7 @@ export class MediaStore {
       uploadId?: string;
       partNumber?: number;
     },
+    traceContext?: MediaTraceContext,
   ): Promise<void>;
 }
 
@@ -1090,9 +1125,7 @@ export type MediaStoreCreateFileParams = {
 };
 
 // @public (undocumented)
-export class MediaStoreError extends BaseMediaClientError<
-  MediaStoreErrorAttributes
-> {
+export class MediaStoreError extends BaseMediaClientError<MediaStoreErrorAttributes> {
   constructor(reason: MediaStoreErrorReason, innerError?: Error | undefined);
   // (undocumented)
   get attributes(): {
@@ -1113,18 +1146,18 @@ export type MediaStoreErrorAttributes = {
 
 // @public (undocumented)
 export type MediaStoreErrorReason =
+  | 'authProviderTimedOut'
+  | 'emptyAuth'
   | 'failedAuthProvider'
-  | 'tokenExpired'
   | 'missingInitialAuth'
-  | 'emptyAuth'
-  | 'authProviderTimedOut';
+  | 'tokenExpired';
 
 // @public (undocumented)
 export type MediaStoreGetCollectionItemsParams = {
   readonly limit?: number;
   readonly inclusiveStartKey?: string;
   readonly sortDirection?: 'asc' | 'desc';
-  readonly details?: 'minimal' | 'full';
+  readonly details?: 'full' | 'minimal';
 };
 
 // @public (undocumented)
@@ -1134,7 +1167,7 @@ export type MediaStoreGetFileImageParams = {
   readonly collection?: string;
   readonly width?: number;
   readonly height?: number;
-  readonly mode?: 'fit' | 'full-fit' | 'crop';
+  readonly mode?: 'crop' | 'fit' | 'full-fit';
   readonly upscale?: boolean;
   readonly 'max-age'?: number;
 };
@@ -1153,6 +1186,7 @@ export type MediaStoreRequestOptions = RequestMetadata & {
   readonly headers?: RequestHeaders;
   readonly body?: any;
   readonly clientOptions?: ClientOptions;
+  readonly traceContext?: MediaTraceContext;
 };
 
 // @public (undocumented)
@@ -1202,7 +1236,7 @@ export interface MediaViewedEventPayload {
   // (undocumented)
   isUserCollection?: boolean;
   // (undocumented)
-  viewingLevel: 'minimal' | 'full' | 'download';
+  viewingLevel: 'download' | 'full' | 'minimal';
 }
 
 // @public (undocumented)
@@ -1255,7 +1289,7 @@ export type NonErrorFileState = Exclude<FileState, ErrorFileState>;
 
 // @public (undocumented)
 export const objectToQueryString: (json: {
-  [key: string]: string | number | boolean | null | undefined;
+  [key: string]: boolean | null | number | string | undefined;
 }) => string;
 
 // @public (undocumented)
@@ -1336,7 +1370,7 @@ export interface PreviewableFileState {
 export interface PreviewOptions {}
 
 // @public (undocumented)
-export interface ProcessedFileState {
+export interface ProcessedFileState extends BaseFileState {
   // (undocumented)
   artifacts: MediaFileArtifacts;
   // (undocumented)
@@ -1362,7 +1396,7 @@ export interface ProcessedFileState {
 }
 
 // @public (undocumented)
-export interface ProcessingFailedState {
+export interface ProcessingFailedState extends BaseFileState {
   // (undocumented)
   artifacts: Object;
   // (undocumented)
@@ -1388,7 +1422,7 @@ export interface ProcessingFailedState {
 }
 
 // @public (undocumented)
-export interface ProcessingFileState {
+export interface ProcessingFileState extends BaseFileState {
   // (undocumented)
   artifacts?: MediaFileArtifacts;
   // (undocumented)
@@ -1464,17 +1498,17 @@ export type RequestErrorMetadata = RequestMetadata & {
 
 // @public (undocumented)
 export type RequestErrorReason =
-  | 'clientOffline'
   | 'clientAbortedRequest'
+  | 'clientOffline'
   | 'clientTimeoutRequest'
-  | 'serverInvalidBody'
+  | 'serverBadGateway'
   | 'serverBadRequest'
-  | 'serverUnauthorized'
   | 'serverForbidden'
+  | 'serverInternalError'
+  | 'serverInvalidBody'
   | 'serverNotFound'
   | 'serverRateLimited'
-  | 'serverInternalError'
-  | 'serverBadGateway'
+  | 'serverUnauthorized'
   | 'serverUnexpectedError';
 
 // @public (undocumented)
@@ -1488,14 +1522,16 @@ export type RequestMetadata = {
   readonly endpoint?: string;
   readonly mediaRegion?: string;
   readonly mediaEnv?: string;
+  readonly traceContext?: MediaTraceContext;
 };
 
 // @public (undocumented)
-export type RequestMethod = 'GET' | 'POST' | 'PUT' | 'DELETE';
+export type RequestMethod = 'DELETE' | 'GET' | 'POST' | 'PUT';
 
 // @public (undocumented)
 export type RequestOptions = RequestMetadata & {
   readonly auth?: Auth;
+  readonly traceContext?: Required<MediaTraceContext>;
   readonly params?: RequestParams;
   readonly headers?: RequestHeaders;
   readonly body?: any;
@@ -1516,6 +1552,8 @@ export interface ResponseFileItem {
   // (undocumented)
   id: string;
   // (undocumented)
+  metadataTraceContext?: MediaTraceContext;
+  // (undocumented)
   type: 'file';
 }
 
@@ -1536,7 +1574,7 @@ export interface SourceFile {
   // (undocumented)
   id: string;
   // (undocumented)
-  owner: ClientAltBasedAuth | AsapBasedAuth;
+  owner: AsapBasedAuth | ClientAltBasedAuth;
   // (undocumented)
   version?: number;
 }
@@ -1607,6 +1645,7 @@ export const uploadFile: (
   store: MediaStore,
   uploadableFileUpfrontIds: UploadableFileUpfrontIds,
   callbacks?: UploadFileCallbacks | undefined,
+  traceContext?: MediaTraceContext | undefined,
 ) => UploadFileResult;
 
 // @public (undocumented)
@@ -1622,7 +1661,7 @@ export interface UploadFileResult {
 }
 
 // @public (undocumented)
-export interface UploadingFileState {
+export interface UploadingFileState extends BaseFileState {
   // (undocumented)
   createdAt?: number;
   // (undocumented)
@@ -1677,3 +1716,5 @@ export type WithMediaClientFunction = <P extends WithMediaClient>(
 
 // (No @packageDocumentation comment for this package)
 ```
+
+<!--SECTION END: Main Entry Types-->

package/dist/types-ts4.0/client/__mocks__/collection-fetcher.d.ts

@@ -1,8 +0,0 @@
-/// <reference types="jest" />
-export declare const collectionCache: {};
-export declare class CollectionFetcher {
-    constructor();
-    getItems: jest.Mock<any, any>;
-    removeFile: jest.Mock<any, any>;
-    loadNextPage: jest.Mock<any, any>;
-}

package/dist/types-ts4.0/client/__mocks__/file-fetcher.d.ts

@@ -1,10 +0,0 @@
-/// <reference types="jest" />
-export declare class FileFetcher {
-    constructor();
-    getFileState: jest.Mock<any, any>;
-    getCurrentState: jest.Mock<any, any>;
-    getArtifactURL: jest.Mock<any, any>;
-    touchFiles: jest.Mock<any, any>;
-    upload: jest.Mock<any, any>;
-    downloadBinary: jest.Mock<any, any>;
-}

package/dist/types-ts4.0/client/__mocks__/media-client.d.ts

@@ -1,13 +0,0 @@
-/// <reference types="jest" />
-import { MediaClientConfig } from '@atlaskit/media-core';
-import { CollectionFetcher } from '../collection-fetcher';
-import { FileFetcher } from '../file-fetcher';
-export declare class MediaClient {
-    readonly config: MediaClientConfig;
-    readonly collection: CollectionFetcher;
-    readonly file: FileFetcher;
-    constructor(config: MediaClientConfig);
-    getImage: jest.Mock<any, any>;
-    getImageUrl: jest.Mock<any, any>;
-    getImageMetadata: jest.Mock<any, any>;
-}