@atlaskit/media-client 14.3.2 → 15.1.0

package/dist/types/client/file-fetcher/index.d.ts

@@ -1,4 +1,3 @@
-import { ReplaySubject } from 'rxjs/ReplaySubject';
 import 'setimmediate';
 import { AuthProvider } from '@atlaskit/media-core';
 import { MediaStore, MediaStoreCopyFileWithTokenParams, TouchedFiles, TouchFileDescriptor } from '../media-store';
@@ -8,6 +7,7 @@ import { UploadableFile, UploadableFileUpfrontIds } from '../../uploader';
 import { MediaFileArtifacts } from '../../models/artifacts';
 import { UploadController } from '../../upload-controller';
 import { Dimensions } from '../../utils/getDimensionsFromBlob';
+import { MediaSubscribable } from '../../utils/toMediaSubscribable';
 export type { FileFetcherErrorAttributes, FileFetcherErrorReason, } from './error';
 export { isFileFetcherError, FileFetcherError } from './error';
 export interface CopySourceFile {
@@ -28,10 +28,10 @@ export declare type ExternalUploadPayload = {
     dimensions: Dimensions;
 };
 export interface FileFetcher {
-    getFileState(id: string, options?: GetFileOptions): ReplaySubject<FileState>;
+    getFileState(id: string, options?: GetFileOptions): MediaSubscribable<FileState>;
     getArtifactURL(artifacts: MediaFileArtifacts, artifactName: keyof MediaFileArtifacts, collectionName?: string): Promise<string>;
     touchFiles(descriptors: TouchFileDescriptor[], collection?: string): Promise<TouchedFiles>;
-    upload(file: UploadableFile, controller?: UploadController, uploadableFileUpfrontIds?: UploadableFileUpfrontIds): ReplaySubject<FileState>;
+    upload(file: UploadableFile, controller?: UploadController, uploadableFileUpfrontIds?: UploadableFileUpfrontIds): MediaSubscribable<FileState>;
     uploadExternal(url: string, collection?: string): Promise<ExternalUploadPayload>;
     downloadBinary(id: string, name?: string, collectionName?: string): Promise<void>;
     getCurrentState(id: string, options?: GetFileOptions): Promise<FileState>;
@@ -42,7 +42,7 @@ export declare class FileFetcherImpl implements FileFetcher {
     private readonly mediaStore;
     private readonly dataloader;
     constructor(mediaStore: MediaStore);
-    getFileState(id: string, options?: GetFileOptions): ReplaySubject<FileState>;
+    getFileState(id: string, options?: GetFileOptions): MediaSubscribable<FileState>;
     getCurrentState(id: string, options?: GetFileOptions): Promise<FileState>;
     getArtifactURL(artifacts: MediaFileArtifacts, artifactName: keyof MediaFileArtifacts, collectionName?: string): Promise<string>;
     getFileBinaryURL(id: string, collectionName?: string): Promise<string>;
@@ -50,7 +50,7 @@ export declare class FileFetcherImpl implements FileFetcher {
     touchFiles(descriptors: TouchFileDescriptor[], collection?: string): Promise<TouchedFiles>;
     private generateUploadableFileUpfrontIds;
     uploadExternal(url: string, collection?: string): Promise<ExternalUploadPayload>;
-    upload(file: UploadableFile, controller?: UploadController, uploadableFileUpfrontIds?: UploadableFileUpfrontIds): ReplaySubject<FileState>;
+    upload(file: UploadableFile, controller?: UploadController, uploadableFileUpfrontIds?: UploadableFileUpfrontIds): MediaSubscribable<FileState>;
     downloadBinary(id: string, name?: string, collectionName?: string): Promise<void>;
     copyFile(source: CopySourceFile, destination: CopyDestination, options?: CopyFileOptions): Promise<MediaFile>;
 }

package/dist/types/client/media-store/resolveAuth.d.ts

@@ -1,4 +1,4 @@
 import { Auth, AuthContext, AuthProvider } from '@atlaskit/media-core';
 export declare const DEFAULT_AUTH_PROVIDER_TIMEOUT = 10000;
 export declare const resolveAuth: (authProvider: AuthProvider, authContext?: AuthContext | undefined, authProviderTimeout?: number) => Promise<Auth>;
-export declare const resolveInitialAuth: (auth?: import("@atlaskit/media-core").ClientBasedAuth | import("@atlaskit/media-core").AsapBasedAuth | undefined) => Auth;
+export declare const resolveInitialAuth: (auth?: Auth | undefined) => Auth;

package/dist/types/globalMediaEventEmitter.d.ts

@@ -1,6 +1,6 @@
 import { UploadEventPayloadMap, EventPayloadListener } from './client/events';
 export declare const globalMediaEventEmitter: {
-    on<E extends "file-added" | "media-viewed">(event: E, listener: EventPayloadListener<UploadEventPayloadMap, E, any>): void;
-    off<E_1 extends "file-added" | "media-viewed">(event: E_1, listener: EventPayloadListener<UploadEventPayloadMap, E_1, any>): void;
-    emit<E_2 extends "file-added" | "media-viewed">(event: E_2, payload: UploadEventPayloadMap[E_2]): boolean | undefined;
+    on<E extends keyof UploadEventPayloadMap>(event: E, listener: EventPayloadListener<UploadEventPayloadMap, E, any>): void;
+    off<E_1 extends keyof UploadEventPayloadMap>(event: E_1, listener: EventPayloadListener<UploadEventPayloadMap, E_1, any>): void;
+    emit<E_2 extends keyof UploadEventPayloadMap>(event: E_2, payload: UploadEventPayloadMap[E_2]): boolean | undefined;
 };

package/dist/types/index.d.ts

@@ -5,6 +5,7 @@ export type { AbortFunction } from './upload-controller';
 export type { MediaItemType, FileItem, FileProcessingStatus, MediaArtifact, Artifacts, FileDetails, } from './models/item';
 export { isPreviewableType, isMediaCollectionItemFullDetails, } from './models/media';
 export type { MediaFileProcessingStatus, MediaType, MediaFile, MediaCollection, MediaCollectionItems, MediaCollectionItem, MediaCollectionItemMinimalDetails, MediaCollectionItemFullDetails, MediaRepresentations, MediaCollectionItemDetails, MediaUpload, MediaChunksProbe, } from './models/media';
+export type { MediaSubscribableItem } from './models/media-subscribable';
 export { getArtifactUrl } from './models/artifacts';
 export type { MediaFileArtifact, MediaFileArtifacts } from './models/artifacts';
 export { isMediaClientError, getMediaClientErrorReason } from './models/errors';
@@ -32,19 +33,20 @@ export { StargateClient } from './client/stargate-client';
 export type { EdgeData } from './client/stargate-client';
 export { isImageRemote } from './utils/isImageRemote';
 export { checkWebpSupport } from './utils/checkWebpSupport';
-export { observableToPromise } from './utils/observableToPromise';
 export { getDimensionsFromBlob } from './utils/getDimensionsFromBlob';
 export type { Dimensions } from './utils/getDimensionsFromBlob';
-export { createFileStateSubject } from './utils/createFileStateSubject';
+export { createMediaSubject } from './utils/createMediaSubject';
 export { safeUnsubscribe } from './utils/safeUnsubscribe';
 export { isFileIdentifier, isExternalImageIdentifier, isDifferentIdentifier, } from './identifier';
 export type { Identifier, FileIdentifier, ExternalImageIdentifier, } from './identifier';
 export type { EventPayloadListener, UploadEventPayloadMap, MediaViewedEventPayload, } from './client/events';
 export { withMediaClient, getMediaClient } from './utils/with-media-client-hoc';
-export type { WithMediaClientConfig, WithMediaClientConfigProps, WithMediaClientFunction, } from './utils/with-media-client-hoc';
+export type { WithMediaClientConfig, WithMediaClientConfigProps, WithMediaClientFunction, WithMediaClient, } from './utils/with-media-client-hoc';
 export { globalMediaEventEmitter } from './globalMediaEventEmitter';
 export { isMediaBlobUrl, getAttrsFromUrl, addFileAttrsToUrl, objectToQueryString, } from './utils/url';
 export type { MediaBlobUrlAttrs } from './utils/url';
+export { createMediaSubscribable } from './utils/toMediaSubscribable';
+export type { MediaSubscribable, MediaSubscription, MediaObserver, } from './utils/toMediaSubscribable';
 export { RECENTS_COLLECTION, MAX_RESOLUTION } from './constants';
 /**
  * @deprecated This export will be removed. Please use one from @atlaskit/media-common or @atlaskit/media-common/mediaTypeUtils

package/dist/types/models/file-state.d.ts

@@ -84,7 +84,7 @@ export declare const isUploadingFileState: (fileState: FileState) => fileState i
 export declare const isProcessingFileState: (fileState: FileState) => fileState is ProcessingFileState;
 export declare const isProcessedFileState: (fileState: FileState) => fileState is ProcessedFileState;
 export declare const isErrorFileState: (fileState: FileState) => fileState is ErrorFileState;
-export declare const isPreviewableFileState: (fileState: FileState) => fileState is (UploadingFileState & PreviewableFileState) | (ProcessingFileState & PreviewableFileState) | (ProcessedFileState & PreviewableFileState) | (ProcessingFailedState & PreviewableFileState);
+export declare const isPreviewableFileState: (fileState: FileState) => fileState is (UploadingFileState | ProcessingFileState | ProcessedFileState | ProcessingFailedState) & PreviewableFileState;
 export declare const isFinalFileState: (fileState: FileState) => fileState is ProcessedFileState | ProcessingFailedState | ErrorFileState;
 export declare const isImageRepresentationReady: (fileState: FileState) => boolean;
 export declare const mapMediaFileToFileState: (mediaFile: MediaStoreResponse<MediaFile>) => FileState;

package/dist/types/models/media-subscribable.d.ts

@@ -0,0 +1,3 @@
+import { FileState } from './file-state';
+import { MediaCollectionItem } from './media';
+export declare type MediaSubscribableItem = FileState | MediaCollectionItem[];

package/dist/types/utils/createMediaSubject.d.ts

@@ -0,0 +1,3 @@
+import { ReplaySubject } from 'rxjs/ReplaySubject';
+import { MediaSubscribableItem } from '../models/media-subscribable';
+export declare function createMediaSubject<T extends MediaSubscribableItem>(initialState?: T | Error): ReplaySubject<T>;

package/dist/types/utils/imageResizeModeToFileImageMode.d.ts

@@ -1,3 +1,3 @@
 import { MediaStoreGetFileImageParams } from '../client/media-store';
 export declare type ImageResizeMode = 'crop' | 'fit' | 'full-fit' | 'stretchy-fit';
-export declare const imageResizeModeToFileImageMode: (resizeMode?: "crop" | "fit" | "full-fit" | "stretchy-fit" | undefined) => MediaStoreGetFileImageParams['mode'];
+export declare const imageResizeModeToFileImageMode: (resizeMode?: ImageResizeMode | undefined) => MediaStoreGetFileImageParams['mode'];

package/dist/types/utils/mediaSubscribableToPromise.d.ts

@@ -0,0 +1,10 @@
+import { Subscription } from 'rxjs/Subscription';
+import { MediaSubscribable } from './toMediaSubscribable';
+import { MediaSubscribableItem } from '../models/media-subscribable';
+/**
+ * This is a helper to transform the first value emitted by an MediaSubscribable into a Promise.
+ *
+ * @param mediaSubscribable a given MediaSubscribable<MediaSubscribableItem>
+ * @param subscription a default Subscription (this parameter exists for testing purpose)
+ */
+export declare const mediaSubscribableToPromise: <T extends MediaSubscribableItem>(mediaSubscribable: MediaSubscribable<T>, subscription?: Subscription) => Promise<T>;

package/dist/types/utils/overrideMediaTypeIfUnknown.d.ts

@@ -1,5 +1,5 @@
 import { FileState } from '../models/file-state';
 import { MediaType } from '../models/media';
-export declare const overrideMediaTypeIfUnknown: (fileState: FileState, mediaType?: "doc" | "audio" | "video" | "image" | "archive" | "unknown" | undefined) => {
-    mediaType?: "doc" | "audio" | "video" | "image" | "archive" | "unknown" | undefined;
+export declare const overrideMediaTypeIfUnknown: (fileState: FileState, mediaType?: MediaType | undefined) => {
+    mediaType?: MediaType | undefined;
 };

package/dist/types/utils/request/errors.d.ts

@@ -7,7 +7,7 @@ export declare class RequestError extends BaseMediaClientError<RequestErrorAttri
     constructor(reason: RequestErrorReason, metadata?: RequestErrorMetadata | undefined, innerError?: Error | undefined);
     get attributes(): {
         reason: RequestErrorReason;
-        method: "GET" | "POST" | "PUT" | "DELETE" | undefined;
+        method: import("./types").RequestMethod | undefined;
         endpoint: string | undefined;
         attempts: number | undefined;
         clientExhaustedRetries: boolean | undefined;

package/dist/types/utils/safeUnsubscribe.d.ts

@@ -1,2 +1,2 @@
-import { Subscription } from 'rxjs/Subscription';
-export declare const safeUnsubscribe: (subscription: Subscription) => void;
+import { MediaSubscription } from './toMediaSubscribable';
+export declare const safeUnsubscribe: (subscription: MediaSubscription) => void;

package/dist/types/utils/toMediaSubscribable.d.ts

@@ -0,0 +1,20 @@
+import { ReplaySubject } from 'rxjs/ReplaySubject';
+import { MediaSubscribableItem } from './../models/media-subscribable';
+export declare type MediaSubscription = {
+    unsubscribe: () => void;
+};
+declare type PartialObserver<T extends MediaSubscribableItem> = {
+    next?: (value: T) => void;
+    error?: (err: any) => void;
+    complete?: () => void;
+};
+declare type NextObserver<T extends MediaSubscribableItem> = PartialObserver<T> & Required<Pick<PartialObserver<T>, 'next'>>;
+declare type ErrorObserver<T extends MediaSubscribableItem> = PartialObserver<T> & Required<Pick<PartialObserver<T>, 'error'>>;
+declare type CompletionObserver<T extends MediaSubscribableItem> = PartialObserver<T> & Required<Pick<PartialObserver<T>, 'complete'>>;
+export declare type MediaObserver<T extends MediaSubscribableItem> = NextObserver<T> | ErrorObserver<T> | CompletionObserver<T> | ((value: T) => void);
+export declare type MediaSubscribable<T extends MediaSubscribableItem> = {
+    subscribe(observer?: MediaObserver<T>): MediaSubscription;
+};
+export declare function toMediaSubscribable<T extends MediaSubscribableItem>(observable: ReplaySubject<T>): MediaSubscribable<T>;
+export declare function createMediaSubscribable<T extends MediaSubscribableItem>(mediaSubscribableItem?: T | Error): MediaSubscribable<T>;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/media-client",
-  "version": "14.3.2",
+  "version": "15.1.0",
   "description": "Media API Web Client Library",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -27,8 +27,8 @@
     }
   },
   "dependencies": {
-    "@atlaskit/chunkinator": "^3.0.0",
-    "@atlaskit/media-common": "^2.10.0",
+    "@atlaskit/chunkinator": "^3.1.0",
+    "@atlaskit/media-common": "^2.12.0",
     "@babel/runtime": "^7.0.0",
     "dataloader": "^2.0.0",
     "deep-equal": "^1.0.1",
@@ -36,6 +36,7 @@
     "lru-fast": "^0.2.2",
     "query-string": "^6.14.1",
     "rusha": "^0.8.13",
+    "rxjs": "^5.5.0",
     "setimmediate": "^1.0.5",
     "uuid": "^3.1.0",
     "uuid-validate": "^0.0.3",
@@ -43,17 +44,15 @@
     "xstate": "^4.20.0"
   },
   "peerDependencies": {
-    "@atlaskit/media-core": "^32.2.0",
-    "react": "^16.8.0",
-    "rxjs": "^5.5.0"
+    "@atlaskit/media-core": "^32.3.1",
+    "react": "^16.8.0"
   },
   "devDependencies": {
-    "@atlaskit/build-utils": "*",
-    "@atlaskit/button": "^16.1.0",
+    "@atlaskit/button": "^16.3.0",
     "@atlaskit/docs": "*",
-    "@atlaskit/media-card": "^73.0.0",
-    "@atlaskit/media-core": "^32.2.0",
-    "@atlaskit/media-test-helpers": "^29.0.0",
+    "@atlaskit/media-card": "^73.5.0",
+    "@atlaskit/media-core": "^32.3.0",
+    "@atlaskit/media-test-helpers": "^29.4.0",
     "@atlaskit/ssr": "*",
     "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
     "@types/deep-equal": "^1.0.1",
@@ -64,9 +63,8 @@
     "jest-fetch-mock": "^3.0.3",
     "react": "^16.8.0",
     "react-dom": "^16.8.0",
-    "rxjs": "^5.5.0",
     "styled-components": "^3.2.6",
-    "typescript": "3.9.6"
+    "typescript": "4.2.4"
   },
   "resolutions": {
     "lru-fast": "0.2.2"

package/dist/es2019/utils/observableToPromise.js

@@ -1,21 +0,0 @@
-import { Subscription } from 'rxjs/Subscription';
-/**
- * We're using this custom helper in place of ".toPromise()" to transform the first value emitted by an Observable or Subject into a Promise.
- * Note that in RxJS 7 ".toPromise()" is deprecated and replaced by "firstValueFrom()/.lastValueFrom()"
- *
- * @param observable a given Observable<T> or Subject<T>
- * @param subscription a default Subscription (this parameter exists for testing purpose)
- */
-
-export const observableToPromise = (observable, subscription = new Subscription()) => {
-  return new Promise((resolve, reject) => subscription.add(observable.subscribe({
-    next: state => {
-      resolve(state);
-      subscription.unsubscribe();
-    },
-    error: error => {
-      reject(error);
-      subscription.unsubscribe();
-    }
-  })));
-};

package/dist/types/utils/createFileStateSubject.d.ts

@@ -1,3 +0,0 @@
-import { ReplaySubject } from 'rxjs/ReplaySubject';
-import { FileState } from '../models/file-state';
-export declare const createFileStateSubject: (initialState?: Error | import("../models/file-state").UploadingFileState | import("../models/file-state").ProcessingFileState | import("../models/file-state").ProcessedFileState | import("../models/file-state").ProcessingFailedState | import("../models/file-state").ErrorFileState | undefined) => ReplaySubject<FileState>;

package/dist/types/utils/observableToPromise.d.ts

@@ -1,10 +0,0 @@
-import { Observable } from 'rxjs/Observable';
-import { Subscription } from 'rxjs/Subscription';
-/**
- * We're using this custom helper in place of ".toPromise()" to transform the first value emitted by an Observable or Subject into a Promise.
- * Note that in RxJS 7 ".toPromise()" is deprecated and replaced by "firstValueFrom()/.lastValueFrom()"
- *
- * @param observable a given Observable<T> or Subject<T>
- * @param subscription a default Subscription (this parameter exists for testing purpose)
- */
-export declare const observableToPromise: <T>(observable: Observable<T>, subscription?: Subscription) => Promise<T>;