@atlaskit/media-client 17.1.2 → 17.1.3

package/dist/types-ts4.0/utils/mediaSubscribable/types.d.ts

@@ -0,0 +1,16 @@
+export declare type MediaSubscription = {
+    unsubscribe: () => void;
+};
+declare type PartialObserver<T> = {
+    next?: (value: T) => void;
+    error?: (err: any) => void;
+    complete?: () => void;
+};
+export declare type NextObserver<T> = PartialObserver<T> & Required<Pick<PartialObserver<T>, 'next'>>;
+export declare type ErrorObserver<T> = PartialObserver<T> & Required<Pick<PartialObserver<T>, 'error'>>;
+export declare type CompletionObserver<T> = PartialObserver<T> & Required<Pick<PartialObserver<T>, 'complete'>>;
+export declare type MediaObserver<T> = NextObserver<T> | ErrorObserver<T> | CompletionObserver<T> | ((value: T) => void);
+export declare type MediaSubscribable<T> = {
+    subscribe(observer?: MediaObserver<T>): MediaSubscription;
+};
+export {};

package/dist/types-ts4.0/utils/mobileUpload/error.d.ts

@@ -0,0 +1,29 @@
+import { BaseMediaClientError } from '../../models/errors';
+export declare type MobileUploadErrorReason = 'emptyItems' | 'zeroVersionFile';
+export declare type MobileUploadErrorAttributes = {
+    readonly reason: MobileUploadErrorReason;
+    readonly id: string;
+    readonly metadata?: {
+        readonly collectionName?: string;
+        readonly occurrenceKey?: string;
+    };
+};
+export declare class MobileUploadError extends BaseMediaClientError<MobileUploadErrorAttributes> {
+    readonly reason: MobileUploadErrorReason;
+    readonly id: string;
+    readonly metadata?: {
+        readonly collectionName?: string | undefined;
+        readonly occurrenceKey?: string | undefined;
+    } | undefined;
+    constructor(reason: MobileUploadErrorReason, id: string, metadata?: {
+        readonly collectionName?: string | undefined;
+        readonly occurrenceKey?: string | undefined;
+    } | undefined);
+    get attributes(): {
+        reason: MobileUploadErrorReason;
+        id: string;
+        collectionName: string | undefined;
+        occurrenceKey: string | undefined;
+    };
+}
+export declare function isMobileUploadError(err: Error): err is MobileUploadError;

package/dist/types-ts4.0/utils/mobileUpload/helpers.d.ts

@@ -0,0 +1,8 @@
+import Dataloader from 'dataloader';
+import { ReplaySubject } from 'rxjs/ReplaySubject';
+import { Interpreter } from 'xstate';
+import { FileState } from '../../models/file-state';
+import { DataloaderKey, DataloaderResult } from '../createFileDataLoader';
+import { StateMachineContext, StateMachineEvent, StateMachineTypestate } from './stateMachine/types';
+export declare const createMobileFileStateSubject: (service: Interpreter<StateMachineContext, any, StateMachineEvent, StateMachineTypestate>) => ReplaySubject<FileState>;
+export declare const createMobileDownloadFileStream: (dataloader: Dataloader<DataloaderKey, DataloaderResult>, id: string, collectionName?: string | undefined, occurrenceKey?: string | undefined) => ReplaySubject<FileState>;

package/dist/types-ts4.0/utils/mobileUpload/index.d.ts

@@ -0,0 +1,5 @@
+export { isMobileUploadError, MobileUploadError } from './error';
+export { createServicesCache } from './servicesCache';
+export { createMobileUploadService, createMobileUploadStateMachine, } from './stateMachine';
+export { createMobileFileStateSubject } from './helpers';
+export type { StateMachineContext, StateMachineSchema, StateMachineEvent, StateMachineTypestate, } from './stateMachine/types';

package/dist/types-ts4.0/utils/mobileUpload/servicesCache.d.ts

@@ -0,0 +1,4 @@
+import { LRUCache } from 'lru-fast';
+import { Interpreter } from 'xstate';
+import { StateMachineContext, StateMachineEvent, StateMachineTypestate } from './stateMachine/types';
+export declare function createServicesCache(): LRUCache<string, Interpreter<StateMachineContext, any, StateMachineEvent, StateMachineTypestate>>;

package/dist/types-ts4.0/utils/mobileUpload/stateMachine/index.d.ts

@@ -0,0 +1,7 @@
+import DataLoader from 'dataloader';
+import { Interpreter, StateMachine } from 'xstate';
+import { UploadingFileState } from '../../../models/file-state';
+import { DataloaderKey, DataloaderResult } from '../../createFileDataLoader';
+import { StateMachineContext, StateMachineEvent, StateMachineSchema, StateMachineTypestate } from './types';
+export declare const createMobileUploadStateMachine: (dataloader: DataLoader<DataloaderKey, DataloaderResult>, initialState: UploadingFileState, collectionName?: string | undefined) => StateMachine<StateMachineContext, any, StateMachineEvent, StateMachineTypestate>;
+export declare function createMobileUploadService(machine: StateMachine<StateMachineContext, StateMachineSchema, StateMachineEvent, StateMachineTypestate>): Interpreter<StateMachineContext, StateMachineSchema, StateMachineEvent, StateMachineTypestate>;

package/dist/types-ts4.0/utils/mobileUpload/stateMachine/states/error.d.ts

@@ -0,0 +1,3 @@
+import { StateNodeConfig } from 'xstate';
+import { StateMachineContext, StateMachineSchema, StateMachineEvent } from '../types';
+export declare const machineErrorState: StateNodeConfig<StateMachineContext, StateMachineSchema, StateMachineEvent>;

package/dist/types-ts4.0/utils/mobileUpload/stateMachine/states/processed.d.ts

@@ -0,0 +1,3 @@
+import { StateNodeConfig } from 'xstate';
+import { StateMachineContext, StateMachineSchema, StateMachineEvent } from '../types';
+export declare const machineProcessedState: StateNodeConfig<StateMachineContext, StateMachineSchema, StateMachineEvent>;

package/dist/types-ts4.0/utils/mobileUpload/stateMachine/states/processing.d.ts

@@ -0,0 +1,3 @@
+import { StateNodeConfig } from 'xstate';
+import { ProcessingStateMachineSchema, StateMachineContext, StateMachineEvent } from '../types';
+export declare const machineProcessingState: StateNodeConfig<StateMachineContext, ProcessingStateMachineSchema, StateMachineEvent>;

package/dist/types-ts4.0/utils/mobileUpload/stateMachine/states/processingFailed.d.ts

@@ -0,0 +1,3 @@
+import { StateNodeConfig } from 'xstate';
+import { StateMachineContext, StateMachineSchema, StateMachineEvent } from '../types';
+export declare const machineProcessingFailedState: StateNodeConfig<StateMachineContext, StateMachineSchema, StateMachineEvent>;

package/dist/types-ts4.0/utils/mobileUpload/stateMachine/states/uploading.d.ts

@@ -0,0 +1,3 @@
+import { StateNodeConfig } from 'xstate';
+import { StateMachineContext, StateMachineSchema, StateMachineEvent } from '../types';
+export declare const machineUploadingState: StateNodeConfig<StateMachineContext, StateMachineSchema, StateMachineEvent>;

package/dist/types-ts4.0/utils/mobileUpload/stateMachine/types.d.ts

@@ -0,0 +1,69 @@
+import { StateSchema } from 'xstate';
+import { FileState, UploadingFileState, ProcessingFileState, ProcessedFileState, ErrorFileState, ProcessingFailedState } from '../../../models/file-state';
+export declare type StateMachineContext = {
+    currentFileState: FileState;
+};
+export declare type StateMachineEvent = {
+    type: 'UPLOAD_PROGRESS';
+    progress: number;
+} | {
+    type: 'UPLOAD_END';
+} | {
+    type: 'UPLOAD_ERROR';
+    message: string;
+} | {
+    type: 'REMOTE_FILESTATE_FETCH';
+} | {
+    type: 'REMOTE_FILESTATE_BYPASS';
+} | {
+    type: 'REMOTE_FILESTATE_RESULT';
+    fileState: FileState;
+} | {
+    type: 'REMOTE_FILESTATE_PROCESSED';
+} | {
+    type: 'REMOTE_FILESTATE_PROCESSING_FAILED';
+} | {
+    type: 'REMOTE_FILESTATE_ERROR';
+};
+export declare type ProcessingStateMachineSchema = StateSchema<StateMachineContext> & {
+    states: {
+        loading: StateSchema<StateMachineContext>;
+        fetchingRemoteFileStates: StateSchema<StateMachineContext>;
+        idle: StateSchema<StateMachineContext>;
+    };
+};
+export declare type StateMachineSchema = StateSchema<StateMachineContext> & {
+    states: {
+        uploading: StateSchema<StateMachineContext>;
+        processing: ProcessingStateMachineSchema;
+        processed: StateSchema<StateMachineContext>;
+        processingFailed: StateSchema<StateMachineContext>;
+        error: StateSchema<StateMachineContext>;
+    };
+};
+export declare type StateMachineTypestate = {
+    value: 'uploading';
+    context: {
+        currentFileState: UploadingFileState;
+    };
+} | {
+    value: 'processing';
+    context: {
+        currentFileState: ProcessingFileState;
+    };
+} | {
+    value: 'processed';
+    context: {
+        currentFileState: ProcessedFileState;
+    };
+} | {
+    value: 'processingFailed';
+    context: {
+        currentFileState: ProcessingFailedState;
+    };
+} | {
+    value: 'error';
+    context: {
+        currentFileState: ErrorFileState;
+    };
+};

package/dist/types-ts4.0/utils/overrideMediaTypeIfUnknown.d.ts

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

package/dist/types-ts4.0/utils/polling/errors.d.ts

@@ -0,0 +1,12 @@
+import { BaseMediaClientError } from '../../models/errors';
+import { PollingErrorReason, PollingErrorAttributes } from './types';
+export declare class PollingError extends BaseMediaClientError<PollingErrorAttributes> {
+    readonly reason: PollingErrorReason;
+    readonly attempts: number;
+    constructor(reason: PollingErrorReason, attempts: number);
+    get attributes(): {
+        reason: "pollingMaxAttemptsExceeded";
+        attempts: number;
+    };
+}
+export declare function isPollingError(err?: Error): err is PollingError;

package/dist/types-ts4.0/utils/polling/index.d.ts

@@ -0,0 +1,33 @@
+import { Executor } from './types';
+export interface PollingOptions {
+    poll_intervalMs: number;
+    poll_maxAttempts: number;
+    poll_backoffFactor: number;
+    poll_maxIntervalMs: number;
+}
+export declare const defaultPollingOptions: PollingOptions;
+/**
+ * This class encapsulates polling functionality with the following features:
+ *
+ *  - async executor function provides each attempt
+ *  - executor will only repeat defined max amount of times (options)
+ *  - each attempt uses a timeout to the next attempt by an interval (ms)
+ *  - each attempt increases the timeout interval by a "poll_backoffFactor"
+ *  - if max attempts are exceeded or executor has exception then onError handler is called
+ *
+ * IMPORTANT! the executor function must explicitly call ".next()" for the next iteration to run
+ */
+export declare class PollingFunction {
+    options: PollingOptions;
+    poll_intervalMs: number;
+    attempt: number;
+    shouldIterate: boolean;
+    onError?: (error: Error) => void;
+    timeoutId: number;
+    constructor(options?: Partial<PollingOptions>);
+    execute(executor: Executor): Promise<void>;
+    private fail;
+    getIntervalMsForIteration(iteration: number): number;
+    next(): void;
+    cancel(): void;
+}

package/dist/types-ts4.0/utils/polling/types.d.ts

@@ -0,0 +1,7 @@
+export declare type Executor = () => Promise<void>;
+export declare type PollingErrorReason = 'pollingMaxAttemptsExceeded';
+export declare type PollingErrorAttributes = {
+    readonly reason: PollingErrorReason;
+    readonly attempts: number;
+    readonly innerError?: Error;
+};

package/dist/types-ts4.0/utils/request/errors.d.ts

@@ -0,0 +1,20 @@
+import { BaseMediaClientError } from '../../models/errors';
+import { RequestErrorReason, RequestErrorMetadata, RequestErrorAttributes } from './types';
+export declare class RequestError extends BaseMediaClientError<RequestErrorAttributes> {
+    readonly reason: RequestErrorReason;
+    readonly metadata?: RequestErrorMetadata | undefined;
+    readonly innerError?: Error | undefined;
+    constructor(reason: RequestErrorReason, metadata?: RequestErrorMetadata | undefined, innerError?: Error | undefined);
+    get attributes(): {
+        reason: RequestErrorReason;
+        method: import("./types").RequestMethod | undefined;
+        endpoint: string | undefined;
+        mediaRegion: string | undefined;
+        mediaEnv: string | undefined;
+        attempts: number | undefined;
+        clientExhaustedRetries: boolean | undefined;
+        statusCode: number | undefined;
+        innerError: Error | undefined;
+    };
+}
+export declare function isRequestError(err: Error): err is RequestError;

package/dist/types-ts4.0/utils/request/helpers.d.ts

@@ -0,0 +1,38 @@
+import { Auth } from '@atlaskit/media-core';
+import { RequestError } from './errors';
+import { CreateUrlOptions, RequestErrorReason, RequestErrorMetadata, RequestHeaders, RequestMetadata, RetryOptions } from './types';
+export declare function clientTimeoutPromise(timeout: number): Promise<Response>;
+export declare function waitPromise(timeout: number): Promise<void>;
+export declare function isAbortedRequestError(err: any): boolean;
+export declare function isFetchNetworkError(err: any): err is TypeError;
+export declare function isRateLimitedError(error: Error | undefined): boolean;
+export declare function mapAuthToRequestHeaders(auth: Auth): RequestHeaders;
+export declare function createUrl(url: string, { params, auth }: CreateUrlOptions): string;
+export declare function withAuth(auth?: Auth): (headers?: RequestHeaders | undefined) => RequestHeaders | undefined;
+/**
+ * @deprecated Helper is deprecated and will be removed in the next major version.
+ * TODO: https://product-fabric.atlassian.net/browse/BMPT-1354
+ */
+export declare function mapResponseToJson(response: Response): Promise<any>;
+/**
+ * @deprecated Helper is deprecated and will be removed in the next major version.
+ * TODO: https://product-fabric.atlassian.net/browse/BMPT-1354
+ */
+export declare function mapResponseToBlob(response: Response): Promise<Blob>;
+/**
+ * @deprecated Helper is deprecated and will be removed in the next major version.
+ * TODO: https://product-fabric.atlassian.net/browse/BMPT-1354
+ */
+export declare function mapResponseToVoid(): Promise<void>;
+export declare function createMapResponseToJson(metadata: RequestMetadata): (response: Response) => Promise<any>;
+export declare function createMapResponseToBlob(metadata: RequestMetadata): (response: Response) => Promise<Blob>;
+export declare const DEFAULT_RETRY_OPTIONS: RetryOptions;
+export declare function cloneRequestError(error: RequestError, extraMetadata: Partial<RequestErrorMetadata>): RequestError;
+export declare function fetchRetry(functionToRetry: () => Promise<Response>, metadata: RequestMetadata, overwriteOptions?: Partial<RetryOptions>): Promise<Response>;
+export declare function createRequestErrorReason(statusCode: number): RequestErrorReason;
+export declare function createRequestErrorFromResponse(metadata: RequestErrorMetadata, response: Response): RequestError;
+export declare function createProcessFetchResponse(metadata: RequestMetadata): (response: Response) => Response;
+export declare function extractMediaHeaders(response: Response): {
+    mediaRegion: string;
+    mediaEnv: string;
+};

package/dist/types-ts4.0/utils/request/index.d.ts

@@ -0,0 +1,5 @@
+import { RequestOptions } from './types';
+export type { RequestErrorReason, RequestErrorMetadata, RequestErrorAttributes, } from './types';
+export { RequestError, isRequestError } from './errors';
+export { isRateLimitedError } from './helpers';
+export declare function request(url: string, options?: RequestOptions, controller?: AbortController): Promise<Response>;

package/dist/types-ts4.0/utils/request/types.d.ts

@@ -0,0 +1,43 @@
+import { Auth } from '@atlaskit/media-core';
+export declare type RequestMethod = 'GET' | 'POST' | 'PUT' | 'DELETE';
+export declare type RequestParams = {
+    [key: string]: any;
+};
+export declare type RequestHeaders = {
+    [key: string]: string;
+};
+export declare type RetryOptions = {
+    readonly startTimeoutInMs: number;
+    readonly maxAttempts: number;
+    readonly factor: number;
+};
+export declare type ClientOptions = {
+    readonly retryOptions?: Partial<RetryOptions>;
+    readonly clientTimeout?: number;
+};
+export declare type RequestMetadata = {
+    readonly method?: RequestMethod;
+    readonly endpoint?: string;
+    readonly mediaRegion?: string;
+    readonly mediaEnv?: string;
+};
+export declare type RequestOptions = RequestMetadata & {
+    readonly auth?: Auth;
+    readonly params?: RequestParams;
+    readonly headers?: RequestHeaders;
+    readonly body?: any;
+    readonly clientOptions?: ClientOptions;
+};
+export declare type CreateUrlOptions = {
+    readonly params?: RequestParams;
+    readonly auth?: Auth;
+};
+export declare type RequestErrorReason = 'clientOffline' | 'clientAbortedRequest' | 'clientTimeoutRequest' | 'serverInvalidBody' | 'serverBadRequest' | 'serverUnauthorized' | 'serverForbidden' | 'serverNotFound' | 'serverRateLimited' | 'serverInternalError' | 'serverBadGateway' | 'serverUnexpectedError';
+export declare type RequestErrorMetadata = RequestMetadata & {
+    readonly attempts?: number;
+    readonly clientExhaustedRetries?: boolean;
+    readonly statusCode?: number;
+};
+export declare type RequestErrorAttributes = RequestErrorMetadata & {
+    readonly reason: RequestErrorReason;
+};

package/dist/types-ts4.0/utils/safeUnsubscribe.d.ts

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

package/dist/types-ts4.0/utils/setTimeoutPromise.d.ts

@@ -0,0 +1,2 @@
+export declare const resolveTimeout: <T>(timeout: number, resolveWith: T) => Promise<T>;
+export declare const rejectTimeout: (timeout: number, rejectWith: Error) => Promise<undefined>;

package/dist/types-ts4.0/utils/shouldFetchRemoteFileStates.d.ts

@@ -0,0 +1,16 @@
+import { Observable } from 'rxjs/Observable';
+import { FilePreview } from '../models/file-state';
+import { MediaType } from '../models/media';
+/**
+ * Async helper determining if we should fetch remote fileStates from the backend:
+ * - we poll the backend for all supported documents,
+ * - we poll the backend is mimeType isn't natively supported by the browser,
+ * - we poll the backend if we don't have a local preview available.
+ * - we poll the backend if we have a video with which we can't extract dimensions,
+ *
+ * Polling the backend periodically refreshes the cached fileState until the file is processed.
+ * Polling is needed for the use cases above to properly render the file in our components.
+ *
+ */
+export declare function shouldFetchRemoteFileStates(mediaType: MediaType, mimeType: string, preview?: FilePreview | Promise<FilePreview>): Promise<boolean>;
+export declare function shouldFetchRemoteFileStatesObservable(mediaType: MediaType, mimeType: string, preview?: FilePreview | Promise<FilePreview>): Observable<boolean>;

package/dist/types-ts4.0/utils/url.d.ts

@@ -0,0 +1,17 @@
+export declare const isMediaBlobUrl: (url: string) => boolean;
+export interface MediaBlobUrlAttrs {
+    id: string;
+    contextId: string;
+    collection?: string;
+    size?: number;
+    name?: string;
+    mimeType?: string;
+    width?: number;
+    height?: number;
+    alt?: string;
+}
+export declare const getAttrsFromUrl: (blobUrl: string) => MediaBlobUrlAttrs | undefined;
+export declare const objectToQueryString: (json: {
+    [key: string]: string | number | boolean | null | undefined;
+}) => string;
+export declare const addFileAttrsToUrl: (url: string, fileAttrs: MediaBlobUrlAttrs) => string;

package/dist/types-ts4.0/utils/with-media-client-hoc.d.ts

@@ -0,0 +1,16 @@
+import React from 'react';
+import { MediaClientConfig } from '@atlaskit/media-core';
+import { MediaFeatureFlags } from '@atlaskit/media-common';
+import { MediaClient } from '../client/media-client';
+import { Identifier } from '../identifier';
+export interface WithMediaClientConfig {
+    mediaClientConfig: MediaClientConfig;
+}
+export interface WithMediaClient {
+    mediaClient: MediaClient;
+    identifier?: Identifier;
+}
+export declare const getMediaClient: (mediaClientConfig: MediaClientConfig, featureFlags?: MediaFeatureFlags | undefined) => MediaClient;
+export declare type WithMediaClientConfigProps<P extends WithMediaClient> = Omit<P, 'mediaClient'> & WithMediaClientConfig;
+export declare type WithMediaClientFunction = <P extends WithMediaClient>(Component: React.ComponentType<P>, featureFlags?: MediaFeatureFlags) => React.ComponentType<WithMediaClientConfigProps<P>>;
+export declare const withMediaClient: WithMediaClientFunction;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/media-client",
-  "version": "17.1.2",
+  "version": "17.1.3",
   "description": "Media API Web Client Library",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -12,6 +12,13 @@
   "module": "dist/esm/index.js",
   "module:es2019": "dist/es2019/index.js",
   "types": "dist/types/index.d.ts",
+  "typesVersions": {
+    ">=4.0 <4.5": {
+      "*": [
+        "dist/types-ts4.0/*"
+      ]
+    }
+  },
   "sideEffects": false,
   "atlaskit:src": "src/index.ts",
   "af:exports": {
@@ -43,7 +50,7 @@
     "xstate": "^4.20.0"
   },
   "peerDependencies": {
-    "@atlaskit/media-core": "^33.0.2",
+    "@atlaskit/media-core": "^33.0.3",
     "@emotion/react": "^11.7.1",
     "react": "^16.8.0"
   },
@@ -62,7 +69,7 @@
     "fetch-mock": "^8.0.0",
     "react": "^16.8.0",
     "react-dom": "^16.8.0",
-    "typescript": "4.3.5"
+    "typescript": "4.5.5"
   },
   "resolutions": {
     "lru-fast": "0.2.2"