@atlaskit/media-client 22.0.0 → 22.0.2

package/dist/types-ts4.5/models/errors/helpers.d.ts

@@ -0,0 +1,6 @@
+export type { MediaClientError, MediaClientErrorReason } from './types';
+import { MediaClientError, MediaClientErrorReason } from './types';
+export declare function isMediaClientError(error: any): error is MediaClientError<{
+    reason: MediaClientErrorReason;
+}>;
+export declare function getMediaClientErrorReason(err: Error): MediaClientErrorReason | 'unknown';

package/dist/types-ts4.5/models/errors/index.d.ts

@@ -0,0 +1,11 @@
+import { MediaClientError, MediaClientErrorAttributes } from './types';
+export type { MediaClientError, MediaClientErrorReason, MediaClientErrorAttributes, } from './types';
+export { isMediaClientError, getMediaClientErrorReason } from './helpers';
+/**
+ * Base class for media errors
+ */
+export declare abstract class BaseMediaClientError<Attributes extends MediaClientErrorAttributes> extends Error implements MediaClientError<Attributes> {
+    readonly message: string;
+    constructor(message: string);
+    abstract get attributes(): Attributes;
+}

package/dist/types-ts4.5/models/errors/types.d.ts

@@ -0,0 +1,15 @@
+export type MediaClientErrorReason = 'clientOffline' | 'clientAbortedRequest' | 'clientTimeoutRequest' | 'serverInvalidBody' | 'serverBadRequest' | 'serverUnauthorized' | 'serverForbidden' | 'serverNotFound' | 'serverRateLimited' | 'serverInternalError' | 'serverBadGateway' | 'serverUnexpectedError' | 'failedAuthProvider' | 'tokenExpired' | 'missingInitialAuth' | 'emptyAuth' | 'authProviderTimedOut' | 'invalidFileId' | 'emptyItems' | 'zeroVersionFile' | 'pollingMaxAttemptsExceeded' | 'fileSizeExceedsLimit' | 'deprecatedEndpoint';
+export interface MediaClientErrorAttributes {
+    reason: MediaClientErrorReason;
+}
+/**
+ * MediaClientError is the main interface which all the errors
+ * in Media Client must implement.
+ * MediaClientErrorReason is a dictionary that restricts all the possible
+ * reasons that the erros can define. Its values are private to this file.
+ * Any new error has to define its own Error Reasons locally, and also declare them
+ * here to comply with the interface restrictions
+ */
+export interface MediaClientError<Attributes extends MediaClientErrorAttributes> extends Error {
+    readonly attributes: Attributes;
+}

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

@@ -0,0 +1,94 @@
+import { FileStatus as CommonFileStatus, MediaTraceContext } from '@atlaskit/media-common';
+import { MediaStoreResponse } from '../client/media-store';
+import { MediaFileArtifacts } from './artifacts';
+import { MediaItemDetails, MediaFile, MediaRepresentations, MediaType } from './media';
+export type BaseFileState = {
+    metadataTraceContext?: MediaTraceContext;
+};
+export type FileStatus = CommonFileStatus;
+export interface FilePreview {
+    value: Blob | string;
+    origin?: 'local' | 'remote';
+    originalDimensions?: {
+        width: number;
+        height: number;
+    };
+}
+export interface PreviewOptions {
+}
+export interface GetFileOptions {
+    preview?: PreviewOptions;
+    collectionName?: string;
+    occurrenceKey?: string;
+}
+export interface UploadingFileState extends BaseFileState {
+    status: 'uploading';
+    id: string;
+    occurrenceKey?: string;
+    name: string;
+    size: number;
+    progress: number;
+    mediaType: MediaType;
+    mimeType: string;
+    preview?: FilePreview | Promise<FilePreview>;
+    createdAt?: number;
+}
+export interface PreviewableFileState {
+    preview: FilePreview | Promise<FilePreview>;
+}
+export interface ProcessingFileState extends BaseFileState {
+    status: 'processing';
+    id: string;
+    occurrenceKey?: string;
+    name: string;
+    size: number;
+    artifacts?: MediaFileArtifacts;
+    mediaType: MediaType;
+    mimeType: string;
+    preview?: FilePreview | Promise<FilePreview>;
+    representations?: MediaRepresentations;
+    createdAt?: number;
+}
+export interface ProcessedFileState extends BaseFileState {
+    status: 'processed';
+    id: string;
+    occurrenceKey?: string;
+    name: string;
+    size: number;
+    artifacts: MediaFileArtifacts;
+    mediaType: MediaType;
+    mimeType: string;
+    preview?: FilePreview | Promise<FilePreview>;
+    representations?: MediaRepresentations;
+    createdAt?: number;
+}
+export interface ProcessingFailedState extends BaseFileState {
+    status: 'failed-processing';
+    id: string;
+    occurrenceKey?: string;
+    name: string;
+    size: number;
+    artifacts: Object;
+    mediaType: MediaType;
+    mimeType: string;
+    preview?: FilePreview | Promise<FilePreview>;
+    representations?: MediaRepresentations;
+    createdAt?: number;
+}
+export interface ErrorFileState extends BaseFileState {
+    status: 'error';
+    id: string;
+    occurrenceKey?: string;
+    message?: string;
+}
+export type FileState = UploadingFileState | ProcessingFileState | ProcessedFileState | ErrorFileState | ProcessingFailedState;
+export type NonErrorFileState = Exclude<FileState, ErrorFileState>;
+export declare const isUploadingFileState: (fileState: FileState) => fileState is UploadingFileState;
+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 | 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;
+export declare const mapMediaItemToFileState: (id: string, item: MediaItemDetails) => FileState;

package/dist/types-ts4.5/models/item.d.ts

@@ -0,0 +1,25 @@
+import { MediaType } from './media';
+export type MediaItemType = 'file' | 'external-image';
+export interface FileItem {
+    type: 'file';
+    details: FileDetails;
+}
+export type FileProcessingStatus = 'pending' | 'running' | 'succeeded' | 'failed';
+export interface MediaArtifact {
+    processingStatus?: FileProcessingStatus;
+    url?: string;
+}
+export type Artifacts = {
+    [name: string]: MediaArtifact;
+};
+export interface FileDetails {
+    id: string;
+    name?: string;
+    size?: number;
+    mimeType?: string;
+    mediaType?: MediaType;
+    creationDate?: number;
+    processingStatus?: FileProcessingStatus;
+    artifacts?: Artifacts;
+    createdAt?: number;
+}

package/dist/types-ts4.5/models/media.d.ts

@@ -0,0 +1,48 @@
+import { MediaFeatureFlags, MediaTraceContext, MediaType } from '@atlaskit/media-common';
+import type { MediaFileArtifacts } from './artifacts';
+export type MediaFileProcessingStatus = 'pending' | 'succeeded' | 'failed';
+export type { MediaType } from '@atlaskit/media-common';
+export declare const isPreviewableType: (type: MediaType, featureFlags?: MediaFeatureFlags) => boolean;
+export type MediaFile = {
+    readonly id: string;
+    readonly mediaType: MediaType;
+    readonly mimeType: string;
+    readonly name: string;
+    readonly processingStatus?: MediaFileProcessingStatus;
+    readonly size: number;
+    readonly artifacts: MediaFileArtifacts;
+    readonly representations: MediaRepresentations;
+    readonly createdAt?: number;
+    readonly metadataTraceContext?: MediaTraceContext;
+};
+export type MediaItemDetails = {
+    readonly mediaType: MediaType;
+    readonly mimeType: string;
+    readonly name: string;
+    readonly processingStatus: MediaFileProcessingStatus;
+    readonly size: number;
+    readonly artifacts: MediaFileArtifacts;
+    readonly representations: MediaRepresentations;
+    readonly createdAt?: number;
+    readonly metadataTraceContext?: MediaTraceContext;
+};
+export type MediaRepresentations = {
+    image?: Object;
+};
+export type MediaUpload = {
+    readonly id: string;
+    readonly created: number;
+    readonly expires: number;
+};
+export type MediaChunksProbe = {
+    readonly results: {
+        readonly [etag: string]: {
+            readonly exists: boolean;
+        };
+    };
+};
+export declare enum DATA_UNIT {
+    MB = 1048576,
+    GB = 1073741824,
+    TB = 1099511627776
+}

package/dist/types-ts4.5/models/mobile-upload.d.ts

@@ -0,0 +1,28 @@
+import { FilePreview } from './file-state';
+export type MobileUploadStartEvent = {
+    fileId: string;
+    collectionName?: string;
+    occurrenceKey?: string;
+    fileName: string;
+    fileSize: number;
+    fileMimetype: string;
+    preview?: FilePreview;
+    createdAt?: number;
+};
+export type MobileUploadProgressEvent = {
+    fileId: string;
+    progress: number;
+};
+export type MobileUploadEndEvent = {
+    fileId: string;
+};
+export type MobileUploadErrorEvent = {
+    fileId: string;
+    message: string;
+};
+export interface MobileUpload {
+    notifyUploadStart(event: MobileUploadStartEvent): void;
+    notifyUploadProgress(event: MobileUploadProgressEvent): void;
+    notifyUploadEnd(event: MobileUploadEndEvent): void;
+    notifyUploadError(event: MobileUploadErrorEvent): void;
+}

package/dist/types-ts4.5/upload-controller.d.ts

@@ -0,0 +1,7 @@
+export type AbortFunction = () => void;
+export declare class UploadController {
+    abortFunction?: AbortFunction;
+    constructor();
+    setAbort(abortFunction: AbortFunction): void;
+    abort(): void;
+}

package/dist/types-ts4.5/uploader/calculateChunkSize.d.ts

@@ -0,0 +1,11 @@
+export declare const fileSizeError = "fileSizeExceedsLimit";
+/**
+ * This is a helper to dynamically calculate the chunk size for a given file size.
+ *
+ * @param fileSize The size of a file to calculate the chunk size for.
+ * @returns A number of bytes per chunk or Throws an Error if the file size exceeds 2TB
+ *
+ * @see {@link https://product-fabric.atlassian.net/wiki/spaces/FIL/pages/3221881143/Rule+of+thumb+for+chunk+sizes#Given-the-following-conditions}
+ *
+ */
+export declare const calculateChunkSize: (fileSize: number) => number;

package/dist/types-ts4.5/uploader/error.d.ts

@@ -0,0 +1,29 @@
+import { BaseMediaClientError } from '../models/errors';
+export type UploaderErrorReason = 'fileSizeExceedsLimit';
+export type UploaderErrorAttributes = {
+    readonly reason: UploaderErrorReason;
+    readonly id: string;
+    readonly metadata?: {
+        readonly collectionName?: string;
+        readonly occurrenceKey?: string;
+    };
+};
+export declare class UploaderError extends BaseMediaClientError<UploaderErrorAttributes> {
+    readonly reason: UploaderErrorReason;
+    readonly id: string;
+    readonly metadata?: {
+        readonly collectionName?: string | undefined;
+        readonly occurrenceKey?: string | undefined;
+    } | undefined;
+    constructor(reason: UploaderErrorReason, id: string, metadata?: {
+        readonly collectionName?: string | undefined;
+        readonly occurrenceKey?: string | undefined;
+    } | undefined);
+    get attributes(): {
+        reason: "fileSizeExceedsLimit";
+        id: string;
+        collectionName: string | undefined;
+        occurrenceKey: string | undefined;
+    };
+}
+export declare function isUploaderError(err: Error): err is UploaderError;

package/dist/types-ts4.5/uploader/index.d.ts

@@ -0,0 +1,22 @@
+import { ChunkinatorFile } from '@atlaskit/chunkinator';
+import { MediaStore } from '../client/media-store';
+import { MediaTraceContext } from '@atlaskit/media-common';
+export type UploadableFile = {
+    content: ChunkinatorFile;
+    name?: string;
+    mimeType?: string;
+    collection?: string;
+};
+export type UploadableFileUpfrontIds = {
+    id: string;
+    deferredUploadId: Promise<string>;
+    occurrenceKey?: string;
+};
+export type UploadFileCallbacks = {
+    onProgress: (progress: number) => void;
+    onUploadFinish: (error?: any) => void;
+};
+export interface UploadFileResult {
+    cancel: () => void;
+}
+export declare const uploadFile: (file: UploadableFile, store: MediaStore, uploadableFileUpfrontIds: UploadableFileUpfrontIds, callbacks?: UploadFileCallbacks, traceContext?: MediaTraceContext) => UploadFileResult;

package/dist/types-ts4.5/utils/checkWebpSupport.d.ts

@@ -0,0 +1 @@
+export declare const checkWebpSupport: () => Promise<boolean>;

package/dist/types-ts4.5/utils/convertBase64ToBlob.d.ts

@@ -0,0 +1 @@
+export declare const convertBase64ToBlob: (base64: string) => Blob;

package/dist/types-ts4.5/utils/createFileDataLoader.d.ts

@@ -0,0 +1,30 @@
+import 'setimmediate';
+import Dataloader from 'dataloader';
+import { MediaStore, ResponseFileItem } from '../client/media-store';
+import { MediaItemDetails } from '../models/media';
+export declare const MAX_BATCH_SIZE = 100;
+export type DataloaderKey = {
+    readonly id: string;
+    readonly collectionName?: string;
+};
+export type DataloaderResult = MediaItemDetails | null;
+export type BatchLoadingErrorResult = {
+    readonly id: string;
+    readonly collection?: string;
+    readonly error: Error;
+};
+export declare const getItemsFromKeys: (dataloaderKeys: ReadonlyArray<DataloaderKey>, fileItems: Array<ResponseFileItem | BatchLoadingErrorResult>) => Array<DataloaderResult | Error>;
+export type FileIdsByCollection = {
+    [collectionName: string]: string[];
+};
+/**
+ * Returns a function that, given Array<DataloaderKey>, resolves to an array of same length containing either DataloaderResult or Error.
+ * Such contract is formalised by Dataloader 1.0, @see https://github.com/graphql/dataloader
+ *
+ * If an Error is resolved in the results, it must be at same position then their corresponding key:
+ * - Dataloader will re-throw that Error when accessing/loading that particular key
+ *
+ * @param mediaStore instance of MediaStore
+ */
+export declare function createBatchLoadingFunc(mediaStore: MediaStore): (keys: ReadonlyArray<DataloaderKey>) => Promise<Array<DataloaderResult | Error>>;
+export declare function createFileDataloader(mediaStore: MediaStore): Dataloader<DataloaderKey, DataloaderResult, DataloaderKey>;

package/dist/types-ts4.5/utils/createMediaSubject.d.ts

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

package/dist/types-ts4.5/utils/detectEmptyFile.d.ts

@@ -0,0 +1,16 @@
+import { MediaItemDetails } from '../models/media';
+/**
+ * EMPTY_FILE_HOURS_ELAPSED_TOLERANCE - how many hours since this file was
+ * created until we give up on expecting metadata?
+ *
+ * Yes, this is not an exact science. Any value under this tolerance will
+ * go undetected, however this is still suitable to catch the majority of
+ * cases where empty (files which never finished upload) are being reloaded.
+ *
+ * Continuous bad renders of empty files will eat our card render SLIs, so until
+ * there is a better response from backend we use this technique.
+ *
+ * Being encapsulated in this function, we can always improve the detection transparently.
+ */
+export declare const EMPTY_FILE_HOURS_ELAPSED_TOLERANCE_MS: number;
+export declare function isEmptyFile(fileDetails: MediaItemDetails, now?: number): Boolean;

package/dist/types-ts4.5/utils/getDimensionsFromBlob.d.ts

@@ -0,0 +1,6 @@
+import { MediaType } from '@atlaskit/media-common';
+export type Dimensions = {
+    width: number;
+    height: number;
+};
+export declare const getDimensionsFromBlob: (mediaType: MediaType, blob: Blob) => Promise<Dimensions>;

package/dist/types-ts4.5/utils/getImageDimensionsFromBlob.d.ts

@@ -0,0 +1,5 @@
+export type Dimensions = {
+    width: number;
+    height: number;
+};
+export declare const getImageDimensionsFromBlob: (url: string) => Promise<Dimensions>;

package/dist/types-ts4.5/utils/getMediaTypeFromUploadableFile.d.ts

@@ -0,0 +1,3 @@
+import { MediaType } from '../models/media';
+import { UploadableFile } from '../uploader';
+export declare const getMediaTypeFromUploadableFile: (file: UploadableFile) => MediaType;

package/dist/types-ts4.5/utils/getVideoDimensionsFromBlob.d.ts

@@ -0,0 +1,5 @@
+export interface Dimensions {
+    width: number;
+    height: number;
+}
+export declare const getVideoDimensionsFromBlob: (blob: Blob) => Promise<Dimensions>;

package/dist/types-ts4.5/utils/hashing/hasher.d.ts

@@ -0,0 +1,3 @@
+export interface Hasher {
+    hash(blob: Blob): Promise<string>;
+}

package/dist/types-ts4.5/utils/hashing/hasherCreator.d.ts

@@ -0,0 +1,3 @@
+import { Hasher } from './hasher';
+export declare const destroyHasher: () => null;
+export declare const createHasher: () => Promise<Hasher>;

package/dist/types-ts4.5/utils/hashing/simpleHasher.d.ts

@@ -0,0 +1,4 @@
+import { Hasher } from './hasher';
+export declare class SimpleHasher implements Hasher {
+    hash(blob: Blob): Promise<string>;
+}

package/dist/types-ts4.5/utils/hashing/workerHasher.d.ts

@@ -0,0 +1,16 @@
+import { Hasher } from './hasher';
+export interface Deferred {
+    resolve: (hash: string) => void;
+    reject: (error: any) => void;
+}
+export declare class WorkerHasher implements Hasher {
+    private workers;
+    private jobs;
+    constructor(numOfWorkers: number);
+    hash(chunk: Blob): Promise<string>;
+    private createWorker;
+    private handleWorkerMessage;
+    private calculateHashInWorker;
+    private dispatch;
+    private getMostRelaxedWorker;
+}

package/dist/types-ts4.5/utils/imageResizeModeToFileImageMode.d.ts

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

package/dist/types-ts4.5/utils/isImageRemote.d.ts

@@ -0,0 +1 @@
+export declare const isImageRemote: (imageUrl: string, windowOrigin?: string) => boolean;

package/dist/types-ts4.5/utils/mediaSubscribable/fromObservable.d.ts

@@ -0,0 +1,5 @@
+import { ReplaySubject } from 'rxjs/ReplaySubject';
+import { FileState } from '../../models/file-state';
+import { MediaSubscribable } from './types';
+export declare function fromObservable(observable: ReplaySubject<FileState>): MediaSubscribable;
+export declare function createMediaSubscribable(item?: FileState | Error): MediaSubscribable;

package/dist/types-ts4.5/utils/mediaSubscribable/index.d.ts

@@ -0,0 +1,3 @@
+export type { MediaSubscribable, MediaObserver, MediaSubscription, } from './types';
+export { toPromise } from './toPromise';
+export { createMediaSubscribable, fromObservable } from './fromObservable';

package/dist/types-ts4.5/utils/mediaSubscribable/toPromise.d.ts

@@ -0,0 +1,10 @@
+import { Subscription } from 'rxjs/Subscription';
+import { MediaSubscribable } from './types';
+import { FileState } from '../../models/file-state';
+/**
+ * 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 toPromise: (mediaSubscribable: MediaSubscribable, subscription?: Subscription) => Promise<FileState>;

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

@@ -0,0 +1,17 @@
+import { FileState } from '../../models/file-state';
+export type MediaSubscription = {
+    unsubscribe: () => void;
+};
+type PartialObserver = {
+    next?: (value: FileState) => void;
+    error?: (err: any) => void;
+    complete?: () => void;
+};
+export type NextObserver = PartialObserver & Required<Pick<PartialObserver, 'next'>>;
+export type ErrorObserver = PartialObserver & Required<Pick<PartialObserver, 'error'>>;
+export type CompletionObserver = PartialObserver & Required<Pick<PartialObserver, 'complete'>>;
+export type MediaObserver = NextObserver | ErrorObserver | CompletionObserver | ((value: FileState) => void);
+export type MediaSubscribable = {
+    subscribe(observer?: MediaObserver): MediaSubscription;
+};
+export {};

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

@@ -0,0 +1,29 @@
+import { BaseMediaClientError } from '../../models/errors';
+export type MobileUploadErrorReason = 'emptyItems' | 'zeroVersionFile';
+export 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.5/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, occurrenceKey?: string) => ReplaySubject<FileState>;

package/dist/types-ts4.5/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.5/utils/mobileUpload/servicesCache.d.ts

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

package/dist/types-ts4.5/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) => StateMachine<StateMachineContext, any, StateMachineEvent, StateMachineTypestate>;
+export declare function createMobileUploadService(machine: StateMachine<StateMachineContext, StateMachineSchema, StateMachineEvent, StateMachineTypestate>): Interpreter<StateMachineContext, StateMachineSchema, StateMachineEvent, StateMachineTypestate>;

package/dist/types-ts4.5/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.5/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.5/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.5/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.5/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.5/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 type StateMachineContext = {
+    currentFileState: FileState;
+};
+export 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 type ProcessingStateMachineSchema = StateSchema<StateMachineContext> & {
+    states: {
+        loading: StateSchema<StateMachineContext>;
+        fetchingRemoteFileStates: StateSchema<StateMachineContext>;
+        idle: StateSchema<StateMachineContext>;
+    };
+};
+export type StateMachineSchema = StateSchema<StateMachineContext> & {
+    states: {
+        uploading: StateSchema<StateMachineContext>;
+        processing: ProcessingStateMachineSchema;
+        processed: StateSchema<StateMachineContext>;
+        processingFailed: StateSchema<StateMachineContext>;
+        error: StateSchema<StateMachineContext>;
+    };
+};
+export 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;
+    };
+};