@uploadcare/upload-client 6.0.1-alpha.8 → 6.1.0-alpha.0

package/dist/index.d.ts

@@ -70,6 +70,43 @@ export declare type ContentInfo = {
 	image?: ImageInfo;
 	video?: VideoInfo;
 };
+export declare type Metadata = Record<string, string>;
+export interface DefaultSettings {
+	baseCDN: string;
+	baseURL: string;
+	maxContentLength: number;
+	retryThrottledRequestMaxTimes: number;
+	retryNetworkErrorMaxTimes: number;
+	multipartMinFileSize: number;
+	multipartChunkSize: number;
+	multipartMinLastPartSize: number;
+	maxConcurrentRequests: number;
+	pollingTimeoutMilliseconds: number;
+	pusherKey: string;
+}
+export interface Settings extends Partial<DefaultSettings> {
+	publicKey: string;
+	fileName?: string;
+	contentType?: string;
+	store?: boolean;
+	secureSignature?: string;
+	secureExpire?: string;
+	integration?: string;
+	userAgent?: CustomUserAgent;
+	checkForUrlDuplicates?: boolean;
+	saveUrlForRecurrentUploads?: boolean;
+	source?: string;
+	jsonpCallback?: string;
+}
+export declare type BrowserFile = Blob | File;
+export declare type NodeFile = Buffer;
+export declare type ReactNativeAsset = {
+	type: string;
+	uri: string;
+	name?: string;
+};
+export declare type SupportedFileInput = BrowserFile | NodeFile | ReactNativeAsset;
+export declare type Sliceable = BrowserFile | NodeFile;
 export declare type FileInfo = {
 	size: number;
 	done: number;
@@ -109,21 +146,6 @@ export declare type UnknownProgressInfo = {
 	isComputable: false;
 };
 export declare type ProgressCallback<T = ComputableProgressInfo | UnknownProgressInfo> = (arg: T) => void;
-export declare type Metadata = {
-	[key: string]: string;
-};
-export declare type Headers = {
-	[key: string]: string | string[] | undefined;
-};
-export declare type ErrorRequestInfo = {
-	method?: string;
-	url: string;
-	query?: string;
-	data?: NodeFormData | FormData | BrowserFile | NodeFile;
-	headers?: Headers;
-};
-export declare type BrowserFile = Blob | File;
-export declare type NodeFile = Buffer;
 export declare type BaseResponse = {
 	file: Uuid;
 };
@@ -148,8 +170,8 @@ export declare type BaseOptions = {
  * Performs file uploading request to Uploadcare Upload API.
  * Can be canceled and has progress.
  */
-export function base(file: NodeFile | BrowserFile, { publicKey, fileName, contentType, baseURL, secureSignature, secureExpire, store, signal, onProgress, source, integration, userAgent, retryThrottledRequestMaxTimes, retryNetworkErrorMaxTimes, metadata }: BaseOptions): Promise<BaseResponse>;
-declare enum TypeEnum {
+export function base(file: SupportedFileInput, { publicKey, fileName, contentType, baseURL, secureSignature, secureExpire, store, signal, onProgress, source, integration, userAgent, retryThrottledRequestMaxTimes, retryNetworkErrorMaxTimes, metadata }: BaseOptions): Promise<BaseResponse>;
+export declare enum TypeEnum {
 	Token = "token",
 	FileInfo = "file_info"
 }
@@ -183,7 +205,7 @@ export declare type FromUrlOptions = {
  * Uploading files from URL.
  */
 export function fromUrl(sourceUrl: Url, { publicKey, baseURL, store, fileName, checkForUrlDuplicates, saveUrlForRecurrentUploads, secureSignature, secureExpire, source, signal, integration, userAgent, retryThrottledRequestMaxTimes, retryNetworkErrorMaxTimes, metadata }: FromUrlOptions): Promise<FromUrlSuccessResponse>;
-declare enum Status {
+export declare enum Status {
 	Unknown = "unknown",
 	Waiting = "waiting",
 	Progress = "progress",
@@ -309,7 +331,7 @@ export declare type MultipartUploadResponse = {
 /**
  * Complete multipart uploading.
  */
-export function multipartUpload(part: NodeFile | BrowserFile, url: MultipartPart, { signal, onProgress, retryThrottledRequestMaxTimes, retryNetworkErrorMaxTimes }: MultipartUploadOptions): Promise<MultipartUploadResponse>;
+export function multipartUpload(part: SupportedFileInput, url: MultipartPart, { signal, onProgress, retryThrottledRequestMaxTimes, retryNetworkErrorMaxTimes }: MultipartUploadOptions): Promise<MultipartUploadResponse>;
 export declare type MultipartCompleteOptions = {
 	publicKey: string;
 	baseURL?: string;
@@ -344,14 +366,13 @@ export declare class UploadcareFile {
 		fileName?: string;
 	});
 }
-export declare type DirectOptions = {
+export declare type FileFromOptions = {
 	publicKey: string;
 	fileName?: string;
 	baseURL?: string;
 	secureSignature?: string;
 	secureExpire?: string;
 	store?: boolean;
-	contentType?: string;
 	signal?: AbortSignal;
 	onProgress?: ProgressCallback;
 	source?: string;
@@ -359,20 +380,28 @@ export declare type DirectOptions = {
 	userAgent?: CustomUserAgent;
 	retryThrottledRequestMaxTimes?: number;
 	retryNetworkErrorMaxTimes?: number;
+	contentType?: string;
+	multipartMinFileSize?: number;
+	multipartChunkSize?: number;
+	maxConcurrentRequests?: number;
 	baseCDN?: string;
+	checkForUrlDuplicates?: boolean;
+	saveUrlForRecurrentUploads?: boolean;
+	pusherKey?: string;
 	metadata?: Metadata;
 };
-export declare const uploadDirect: (file: NodeFile | BrowserFile, { publicKey, fileName, baseURL, secureSignature, secureExpire, store, contentType, signal, onProgress, source, integration, userAgent, retryThrottledRequestMaxTimes, retryNetworkErrorMaxTimes, baseCDN, metadata }: DirectOptions) => Promise<UploadcareFile>;
-export declare type UploadFromUrlOptions = {
-	baseCDN?: string;
-	onProgress?: ProgressCallback;
-	pusherKey?: string;
-} & FromUrlOptions;
-export declare const uploadFromUrl: (sourceUrl: string, { publicKey, fileName, baseURL, baseCDN, checkForUrlDuplicates, saveUrlForRecurrentUploads, secureSignature, secureExpire, store, signal, onProgress, source, integration, userAgent, retryThrottledRequestMaxTimes, pusherKey, metadata }: UploadFromUrlOptions) => Promise<UploadcareFile>;
-export declare type FromUploadedOptions = {
+/**
+ * Uploads file from provided data.
+ */
+export declare function uploadFile(data: SupportedFileInput | Url | Uuid, { publicKey, fileName, baseURL, secureSignature, secureExpire, store, signal, onProgress, source, integration, userAgent, retryThrottledRequestMaxTimes, retryNetworkErrorMaxTimes, contentType, multipartMinFileSize, multipartChunkSize, maxConcurrentRequests, baseCDN, checkForUrlDuplicates, saveUrlForRecurrentUploads, pusherKey, metadata }: FileFromOptions): Promise<UploadcareFile>;
+export declare type DirectOptions = {
 	publicKey: string;
 	fileName?: string;
 	baseURL?: string;
+	secureSignature?: string;
+	secureExpire?: string;
+	store?: boolean;
+	contentType?: string;
 	signal?: AbortSignal;
 	onProgress?: ProgressCallback;
 	source?: string;
@@ -381,58 +410,51 @@ export declare type FromUploadedOptions = {
 	retryThrottledRequestMaxTimes?: number;
 	retryNetworkErrorMaxTimes?: number;
 	baseCDN?: string;
+	metadata?: Metadata;
 };
-export declare const uploadFromUploaded: (uuid: Uuid, { publicKey, fileName, baseURL, signal, onProgress, source, integration, userAgent, retryThrottledRequestMaxTimes, retryNetworkErrorMaxTimes, baseCDN }: FromUploadedOptions) => Promise<UploadcareFile>;
-export declare type MultipartOptions = {
+export declare const uploadDirect: (file: SupportedFileInput, { publicKey, fileName, baseURL, secureSignature, secureExpire, store, contentType, signal, onProgress, source, integration, userAgent, retryThrottledRequestMaxTimes, retryNetworkErrorMaxTimes, baseCDN, metadata }: DirectOptions) => Promise<UploadcareFile>;
+export declare type FromUploadedOptions = {
 	publicKey: string;
-	contentType?: string;
-	multipartChunkSize?: number;
 	fileName?: string;
-	fileSize?: number;
 	baseURL?: string;
-	secureSignature?: string;
-	secureExpire?: string;
-	store?: boolean;
 	signal?: AbortSignal;
-	onProgress?: ProgressCallback<ComputableProgressInfo>;
+	onProgress?: ProgressCallback;
 	source?: string;
 	integration?: string;
 	userAgent?: CustomUserAgent;
 	retryThrottledRequestMaxTimes?: number;
 	retryNetworkErrorMaxTimes?: number;
-	maxConcurrentRequests?: number;
 	baseCDN?: string;
-	metadata?: Metadata;
 };
-export declare const uploadMultipart: (file: NodeFile | BrowserFile, { publicKey, fileName, fileSize, baseURL, secureSignature, secureExpire, store, signal, onProgress, source, integration, userAgent, retryThrottledRequestMaxTimes, retryNetworkErrorMaxTimes, contentType, multipartChunkSize, maxConcurrentRequests, baseCDN, metadata }: MultipartOptions) => Promise<UploadcareFile>;
-export declare type FileFromOptions = {
+export declare const uploadFromUploaded: (uuid: Uuid, { publicKey, fileName, baseURL, signal, onProgress, source, integration, userAgent, retryThrottledRequestMaxTimes, retryNetworkErrorMaxTimes, baseCDN }: FromUploadedOptions) => Promise<UploadcareFile>;
+export declare type UploadFromUrlOptions = {
+	baseCDN?: string;
+	onProgress?: ProgressCallback;
+	pusherKey?: string;
+} & FromUrlOptions;
+export declare const uploadFromUrl: (sourceUrl: string, { publicKey, fileName, baseURL, baseCDN, checkForUrlDuplicates, saveUrlForRecurrentUploads, secureSignature, secureExpire, store, signal, onProgress, source, integration, userAgent, retryThrottledRequestMaxTimes, pusherKey, metadata }: UploadFromUrlOptions) => Promise<UploadcareFile>;
+export declare type MultipartOptions = {
 	publicKey: string;
+	contentType?: string;
+	multipartChunkSize?: number;
 	fileName?: string;
+	fileSize?: number;
 	baseURL?: string;
 	secureSignature?: string;
 	secureExpire?: string;
 	store?: boolean;
 	signal?: AbortSignal;
-	onProgress?: ProgressCallback;
+	onProgress?: ProgressCallback<ComputableProgressInfo>;
 	source?: string;
 	integration?: string;
 	userAgent?: CustomUserAgent;
 	retryThrottledRequestMaxTimes?: number;
 	retryNetworkErrorMaxTimes?: number;
-	contentType?: string;
-	multipartMinFileSize?: number;
-	multipartChunkSize?: number;
 	maxConcurrentRequests?: number;
 	baseCDN?: string;
-	checkForUrlDuplicates?: boolean;
-	saveUrlForRecurrentUploads?: boolean;
-	pusherKey?: string;
 	metadata?: Metadata;
 };
-/**
- * Uploads file from provided data.
- */
-export declare function uploadFile(data: NodeFile | BrowserFile | Url | Uuid, { publicKey, fileName, baseURL, secureSignature, secureExpire, store, signal, onProgress, source, integration, userAgent, retryThrottledRequestMaxTimes, retryNetworkErrorMaxTimes, contentType, multipartMinFileSize, multipartChunkSize, maxConcurrentRequests, baseCDN, checkForUrlDuplicates, saveUrlForRecurrentUploads, pusherKey, metadata }: FileFromOptions): Promise<UploadcareFile>;
+export declare const uploadMultipart: (file: SupportedFileInput, { publicKey, fileName, fileSize, baseURL, secureSignature, secureExpire, store, signal, onProgress, source, integration, userAgent, retryThrottledRequestMaxTimes, retryNetworkErrorMaxTimes, contentType, multipartChunkSize, maxConcurrentRequests, baseCDN, metadata }: MultipartOptions) => Promise<UploadcareFile>;
 export declare class UploadcareGroup {
 	readonly uuid: GroupId;
 	readonly filesCount: string;
@@ -448,51 +470,34 @@ export declare class UploadcareGroup {
 export declare type GroupFromOptions = {
 	jsonpCallback?: string;
 };
-export function uploadFileGroup(data: (NodeFile | BrowserFile)[] | Url[] | Uuid[], { publicKey, fileName, baseURL, secureSignature, secureExpire, store, signal, onProgress, source, integration, userAgent, retryThrottledRequestMaxTimes, retryNetworkErrorMaxTimes, contentType, multipartChunkSize, baseCDN, jsonpCallback }: FileFromOptions & GroupFromOptions): Promise<UploadcareGroup>;
-export interface DefaultSettings {
-	baseCDN: string;
-	baseURL: string;
-	maxContentLength: number;
-	retryThrottledRequestMaxTimes: number;
-	retryNetworkErrorMaxTimes: number;
-	multipartMinFileSize: number;
-	multipartChunkSize: number;
-	multipartMinLastPartSize: number;
-	maxConcurrentRequests: number;
-	pollingTimeoutMilliseconds: number;
-	pusherKey: string;
-}
-export interface Settings extends Partial<DefaultSettings> {
-	publicKey: string;
-	fileName?: string;
-	contentType?: string;
-	store?: boolean;
-	secureSignature?: string;
-	secureExpire?: string;
-	integration?: string;
-	userAgent?: CustomUserAgent;
-	checkForUrlDuplicates?: boolean;
-	saveUrlForRecurrentUploads?: boolean;
-	source?: string;
-	jsonpCallback?: string;
-}
+export declare function uploadFileGroup(data: SupportedFileInput[] | Url[] | Uuid[], { publicKey, fileName, baseURL, secureSignature, secureExpire, store, signal, onProgress, source, integration, userAgent, retryThrottledRequestMaxTimes, retryNetworkErrorMaxTimes, contentType, multipartChunkSize, baseCDN, jsonpCallback }: FileFromOptions & GroupFromOptions): Promise<UploadcareGroup>;
 export declare class UploadClient {
 	private settings;
 	constructor(settings: Settings);
 	updateSettings(newSettings: Settings): void;
 	getSettings(): Settings;
-	base(file: NodeFile | BrowserFile, options?: Partial<BaseOptions>): Promise<BaseResponse>;
+	base(file: SupportedFileInput, options?: Partial<BaseOptions>): Promise<BaseResponse>;
 	info(uuid: Uuid, options?: Partial<InfoOptions>): Promise<FileInfo>;
 	fromUrl(sourceUrl: Url, options?: Partial<FromUrlOptions>): Promise<FromUrlResponse>;
 	fromUrlStatus(token: Token, options?: Partial<FromUrlStatusOptions>): Promise<FromUrlStatusResponse>;
 	group(uuids: Uuid[], options?: Partial<GroupOptions>): Promise<GroupInfo>;
 	groupInfo(id: GroupId, options?: Partial<GroupInfoOptions>): Promise<GroupInfo>;
 	multipartStart(size: number, options?: Partial<MultipartStartOptions>): Promise<MultipartStartResponse>;
-	multipartUpload(part: Buffer | Blob, url: MultipartPart, options?: Partial<MultipartUploadOptions>): Promise<MultipartUploadResponse>;
+	multipartUpload(part: Sliceable, url: MultipartPart, options?: Partial<MultipartUploadOptions>): Promise<MultipartUploadResponse>;
 	multipartComplete(uuid: Uuid, options?: Partial<MultipartCompleteOptions>): Promise<FileInfo>;
-	uploadFile(data: NodeFile | BrowserFile | Url | Uuid, options?: Partial<FileFromOptions>): Promise<UploadcareFile>;
-	uploadFileGroup(data: (NodeFile | BrowserFile)[] | Url[] | Uuid[], options?: Partial<FileFromOptions & GroupFromOptions>): Promise<UploadcareGroup>;
+	uploadFile(data: SupportedFileInput | Url | Uuid, options?: Partial<FileFromOptions>): Promise<UploadcareFile>;
+	uploadFileGroup(data: SupportedFileInput[] | Url[] | Uuid[], options?: Partial<FileFromOptions & GroupFromOptions>): Promise<UploadcareGroup>;
 }
+export declare type Headers = {
+	[key: string]: string | string[] | undefined;
+};
+export declare type ErrorRequestInfo = {
+	method?: string;
+	url: string;
+	query?: string;
+	data?: NodeFormData | FormData | SupportedFileInput;
+	headers?: Headers;
+};
 export declare type ErrorResponseInfo = {
 	error?: {
 		statusCode: number;