@uploadcare/upload-client 2.0.0-alpha.6 → 2.0.0

package/dist/types.d.ts

@@ -1,4 +1,4 @@
-// Generated by dts-bundle-generator v5.3.0
+// Generated by dts-bundle-generator v5.4.0
 
 /// <reference types="node" />
 
@@ -71,42 +71,6 @@ export declare type Url = string;
 export declare type ProgressCallback = (arg: {
 	value: number;
 }) => void;
-declare class UploadcareFile {
-	readonly uuid: Uuid;
-	readonly name: null | string;
-	readonly size: null | number;
-	readonly isStored: null | boolean;
-	readonly isImage: null | boolean;
-	readonly cdnUrl: null | string;
-	readonly cdnUrlModifiers: null | string;
-	readonly originalUrl: null | string;
-	readonly originalFilename: null | string;
-	readonly imageInfo: null | ImageInfo;
-	readonly videoInfo: null | VideoInfo;
-	constructor(fileInfo: FileInfo, { baseCDN, defaultEffects, fileName }: {
-		baseCDN?: string;
-		defaultEffects?: string;
-		fileName?: string;
-	});
-}
-declare class UploadcareGroup {
-	readonly uuid: GroupId;
-	readonly filesCount: string;
-	readonly totalSize: number;
-	readonly isStored: boolean;
-	readonly isImage: boolean;
-	readonly cdnUrl: string;
-	readonly files: UploadcareFile[];
-	readonly createdAt: string;
-	readonly storedAt: string | null;
-	constructor(groupInfo: GroupInfo, files: UploadcareFile[]);
-}
-/**
- * Make all properties in T optional
- */
-export declare type Partial<T> = {
-	[P in keyof T]?: T[P];
-};
 export interface DefaultSettings {
 	baseCDN: string;
 	baseURL: string;
@@ -122,15 +86,27 @@ export interface DefaultSettings {
 }
 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 CustomUserAgentOptions = {
+	publicKey: string;
+	libraryName: string;
+	libraryVersion: string;
+	languageName: string;
+	integration?: string;
+};
+export declare type CustomUserAgentFn = (options: CustomUserAgentOptions) => string;
+export declare type CustomUserAgent = string | CustomUserAgentFn;
 export declare type BrowserFile = Blob | File;
 export declare type NodeFile = Buffer;
 export declare type BaseResponse = {
@@ -147,28 +123,10 @@ export declare type BaseOptions = {
 	onProgress?: ProgressCallback;
 	source?: string;
 	integration?: string;
+	userAgent?: CustomUserAgent;
 	retryThrottledRequestMaxTimes?: number;
 };
-/**
- * Performs file uploading request to Uploadcare Upload API.
- * Can be canceled and has progress.
- */
-export declare function base(file: NodeFile | BrowserFile, { publicKey, fileName, baseURL, secureSignature, secureExpire, store, signal, onProgress, source, integration, retryThrottledRequestMaxTimes }: BaseOptions): Promise<BaseResponse>;
-export declare type InfoOptions = {
-	publicKey: string;
-	baseURL?: string;
-	signal?: AbortSignal;
-	onProgress?: ({ value: number }: {
-		value: any;
-	}) => void;
-	source?: string;
-	integration?: string;
-	retryThrottledRequestMaxTimes?: number;
-};
-/**
- * Returns a JSON dictionary holding file info.
- */
-export declare function info(uuid: Uuid, { publicKey, baseURL, signal, source, integration, retryThrottledRequestMaxTimes }: InfoOptions): Promise<FileInfo>;
+declare function base(file: NodeFile | BrowserFile, { publicKey, fileName, baseURL, secureSignature, secureExpire, store, signal, onProgress, source, integration, userAgent, retryThrottledRequestMaxTimes }: BaseOptions): Promise<BaseResponse>;
 declare enum TypeEnum {
 	Token = "token",
 	FileInfo = "file_info"
@@ -194,12 +152,10 @@ export declare type FromUrlOptions = {
 	signal?: AbortSignal;
 	source?: string;
 	integration?: string;
+	userAgent?: CustomUserAgent;
 	retryThrottledRequestMaxTimes?: number;
 };
-/**
- * Uploading files from URL.
- */
-export declare function fromUrl(sourceUrl: Url, { publicKey, baseURL, store, fileName, checkForUrlDuplicates, saveUrlForRecurrentUploads, secureSignature, secureExpire, source, signal, integration, retryThrottledRequestMaxTimes }: FromUrlOptions): Promise<FromUrlSuccessResponse>;
+declare function fromUrl(sourceUrl: Url, { publicKey, baseURL, store, fileName, checkForUrlDuplicates, saveUrlForRecurrentUploads, secureSignature, secureExpire, source, signal, integration, userAgent, retryThrottledRequestMaxTimes }: FromUrlOptions): Promise<FromUrlSuccessResponse>;
 declare enum Status {
 	Unknown = "unknown",
 	Waiting = "waiting",
@@ -222,6 +178,7 @@ export declare type StatusProgressResponse = {
 export declare type StatusErrorResponse = {
 	status: Status.Error;
 	error: string;
+	errorCode: string;
 };
 export declare type StatusSuccessResponse = {
 	status: Status.Success;
@@ -232,12 +189,10 @@ export declare type FromUrlStatusOptions = {
 	baseURL?: string;
 	signal?: AbortSignal;
 	integration?: string;
+	userAgent?: CustomUserAgent;
 	retryThrottledRequestMaxTimes?: number;
 };
-/**
- * Checking upload status and working with file tokens.
- */
-export declare function fromUrlStatus(token: Token, { publicKey, baseURL, signal, integration, retryThrottledRequestMaxTimes }?: FromUrlStatusOptions): Promise<FromUrlStatusResponse>;
+declare function fromUrlStatus(token: Token, { publicKey, baseURL, signal, integration, userAgent, retryThrottledRequestMaxTimes }?: FromUrlStatusOptions): Promise<FromUrlStatusResponse>;
 export declare type GroupOptions = {
 	publicKey: string;
 	baseURL?: string;
@@ -247,24 +202,30 @@ export declare type GroupOptions = {
 	signal?: AbortSignal;
 	source?: string;
 	integration?: string;
+	userAgent?: CustomUserAgent;
 	retryThrottledRequestMaxTimes?: number;
 };
-/**
- * Create files group.
- */
-export declare function group(uuids: Uuid[], { publicKey, baseURL, jsonpCallback, secureSignature, secureExpire, signal, source, integration, retryThrottledRequestMaxTimes }: GroupOptions): Promise<GroupInfo>;
+declare function group(uuids: Uuid[], { publicKey, baseURL, jsonpCallback, secureSignature, secureExpire, signal, source, integration, userAgent, retryThrottledRequestMaxTimes }: GroupOptions): Promise<GroupInfo>;
 export declare type GroupInfoOptions = {
 	publicKey: string;
 	baseURL?: string;
 	signal?: AbortSignal;
 	source?: string;
 	integration?: string;
+	userAgent?: CustomUserAgent;
 	retryThrottledRequestMaxTimes?: number;
 };
-/**
- * Get info about group.
- */
-export declare function groupInfo(id: GroupId, { publicKey, baseURL, signal, source, integration, retryThrottledRequestMaxTimes }: GroupInfoOptions): Promise<GroupInfo>;
+declare function groupInfo(id: GroupId, { publicKey, baseURL, signal, source, integration, userAgent, retryThrottledRequestMaxTimes }: GroupInfoOptions): Promise<GroupInfo>;
+export declare type InfoOptions = {
+	publicKey: string;
+	baseURL?: string;
+	signal?: AbortSignal;
+	source?: string;
+	integration?: string;
+	userAgent?: CustomUserAgent;
+	retryThrottledRequestMaxTimes?: number;
+};
+declare function info(uuid: Uuid, { publicKey, baseURL, signal, source, integration, userAgent, retryThrottledRequestMaxTimes }: InfoOptions): Promise<FileInfo>;
 export declare type MultipartStartOptions = {
 	publicKey: string;
 	contentType?: string;
@@ -277,6 +238,7 @@ export declare type MultipartStartOptions = {
 	signal?: AbortSignal;
 	source?: string;
 	integration?: string;
+	userAgent?: CustomUserAgent;
 	retryThrottledRequestMaxTimes?: number;
 };
 export declare type MultipartPart = string;
@@ -284,36 +246,103 @@ export declare type MultipartStartResponse = {
 	parts: MultipartPart[];
 	uuid: Uuid;
 };
-/**
- * Start multipart uploading.
- */
-export declare function multipartStart(size: number, { publicKey, contentType, fileName, multipartChunkSize, baseURL, secureSignature, secureExpire, store, signal, source, integration, retryThrottledRequestMaxTimes }: MultipartStartOptions): Promise<MultipartStartResponse>;
+declare function multipartStart(size: number, { publicKey, contentType, fileName, multipartChunkSize, baseURL, secureSignature, secureExpire, store, signal, source, integration, userAgent, retryThrottledRequestMaxTimes }: MultipartStartOptions): Promise<MultipartStartResponse>;
+export declare type MultipartUploadOptions = {
+	publicKey?: string;
+	signal?: AbortSignal;
+	onProgress?: ProgressCallback;
+	integration?: string;
+	retryThrottledRequestMaxTimes?: number;
+};
+export declare type MultipartUploadResponse = {
+	code?: number;
+};
+declare function multipartUpload(part: NodeFile | BrowserFile, url: MultipartPart, { signal, onProgress }: MultipartUploadOptions): Promise<MultipartUploadResponse>;
 export declare type MultipartCompleteOptions = {
 	publicKey: string;
 	baseURL?: string;
 	signal?: AbortSignal;
 	source?: string;
 	integration?: string;
+	userAgent?: CustomUserAgent;
 	retryThrottledRequestMaxTimes?: number;
 };
-/**
- * Complete multipart uploading.
- */
-export declare function multipartComplete(uuid: Uuid, { publicKey, baseURL, source, signal, integration, retryThrottledRequestMaxTimes }: MultipartCompleteOptions): Promise<FileInfo>;
-export declare type MultipartUploadOptions = {
-	publicKey?: string;
+declare function multipartComplete(uuid: Uuid, { publicKey, baseURL, source, signal, integration, userAgent, retryThrottledRequestMaxTimes }: MultipartCompleteOptions): Promise<FileInfo>;
+declare class UploadcareFile {
+	readonly uuid: Uuid;
+	readonly name: null | string;
+	readonly size: null | number;
+	readonly isStored: null | boolean;
+	readonly isImage: null | boolean;
+	readonly mimeType: null | string;
+	readonly cdnUrl: null | string;
+	readonly cdnUrlModifiers: null | string;
+	readonly originalUrl: null | string;
+	readonly originalFilename: null | string;
+	readonly imageInfo: null | ImageInfo;
+	readonly videoInfo: null | VideoInfo;
+	constructor(fileInfo: FileInfo, { baseCDN, defaultEffects, fileName }: {
+		baseCDN?: string;
+		defaultEffects?: string;
+		fileName?: string;
+	});
+}
+export declare type FromObjectOptions = {
+	publicKey: string;
+	fileName?: string;
+	baseURL?: string;
+	secureSignature?: string;
+	secureExpire?: string;
+	store?: boolean;
 	signal?: AbortSignal;
 	onProgress?: ProgressCallback;
+	source?: string;
 	integration?: string;
+	userAgent?: CustomUserAgent;
 	retryThrottledRequestMaxTimes?: number;
+	baseCDN?: string;
 };
-export declare type MultipartUploadResponse = {
-	code?: number;
+declare const uploadFromObject: (file: NodeFile | BrowserFile, { publicKey, fileName, baseURL, secureSignature, secureExpire, store, signal, onProgress, source, integration, userAgent, retryThrottledRequestMaxTimes, baseCDN }: FromObjectOptions) => 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 }: UploadFromUrlOptions) => Promise<UploadcareFile>;
+export declare type FromUploadedOptions = {
+	publicKey: string;
+	fileName?: string;
+	baseURL?: string;
+	signal?: AbortSignal;
+	onProgress?: ProgressCallback;
+	source?: string;
+	integration?: string;
+	userAgent?: CustomUserAgent;
+	retryThrottledRequestMaxTimes?: number;
+	baseCDN?: string;
 };
-/**
- * Complete multipart uploading.
- */
-export declare function multipartUpload(part: NodeFile | BrowserFile, url: MultipartPart, { publicKey, signal, onProgress, integration }: MultipartUploadOptions): Promise<MultipartUploadResponse>;
+export declare const uploadFromUploaded: (uuid: Uuid, { publicKey, fileName, baseURL, signal, onProgress, source, integration, userAgent, retryThrottledRequestMaxTimes, baseCDN }: FromUploadedOptions) => 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;
+	source?: string;
+	integration?: string;
+	userAgent?: CustomUserAgent;
+	retryThrottledRequestMaxTimes?: number;
+	maxConcurrentRequests?: number;
+	multipartMaxAttempts?: number;
+	baseCDN?: string;
+};
+export declare const uploadMultipart: (file: NodeFile | BrowserFile, { publicKey, fileName, fileSize, baseURL, secureSignature, secureExpire, store, signal, onProgress, source, integration, userAgent, retryThrottledRequestMaxTimes, contentType, multipartChunkSize, maxConcurrentRequests, multipartMaxAttempts, baseCDN }: MultipartOptions) => Promise<UploadcareFile>;
 export declare type FileFromOptions = {
 	publicKey: string;
 	fileName?: string;
@@ -325,21 +354,39 @@ export declare type FileFromOptions = {
 	onProgress?: ProgressCallback;
 	source?: string;
 	integration?: string;
+	userAgent?: CustomUserAgent;
 	retryThrottledRequestMaxTimes?: number;
 	contentType?: string;
 	multipartChunkSize?: number;
+	multipartMaxAttempts?: number;
+	maxConcurrentRequests?: number;
 	baseCDN?: string;
+	checkForUrlDuplicates?: boolean;
+	saveUrlForRecurrentUploads?: boolean;
+	pusherKey?: string;
 };
 /**
  * Uploads file from provided data.
  */
-export declare function uploadFile(data: NodeFile | BrowserFile | Url | Uuid, { publicKey, fileName, baseURL, secureSignature, secureExpire, store, signal, onProgress, source, integration, retryThrottledRequestMaxTimes, contentType, multipartChunkSize, baseCDN }: FileFromOptions): Promise<UploadcareFile>;
+export declare function uploadFile(data: NodeFile | BrowserFile | Url | Uuid, { publicKey, fileName, baseURL, secureSignature, secureExpire, store, signal, onProgress, source, integration, userAgent, retryThrottledRequestMaxTimes, contentType, multipartChunkSize, multipartMaxAttempts, maxConcurrentRequests, baseCDN, checkForUrlDuplicates, saveUrlForRecurrentUploads, pusherKey }: FileFromOptions): Promise<UploadcareFile>;
+declare class UploadcareGroup {
+	readonly uuid: GroupId;
+	readonly filesCount: string;
+	readonly totalSize: number;
+	readonly isStored: boolean;
+	readonly isImage: boolean;
+	readonly cdnUrl: string;
+	readonly files: UploadcareFile[];
+	readonly createdAt: string;
+	readonly storedAt: string | null;
+	constructor(groupInfo: GroupInfo, files: UploadcareFile[]);
+}
 export declare type GroupFromOptions = {
 	defaultEffects?: string;
 	jsonpCallback?: string;
 };
-export declare function uploadFileGroup(data: (NodeFile | BrowserFile)[] | Url[] | Uuid[], { publicKey, fileName, baseURL, secureSignature, secureExpire, store, signal, onProgress, source, integration, retryThrottledRequestMaxTimes, contentType, multipartChunkSize, baseCDN, jsonpCallback, defaultEffects }: FileFromOptions & GroupFromOptions): Promise<UploadcareGroup>;
-export declare class UploadClient {
+declare function uploadFileGroup(data: (NodeFile | BrowserFile)[] | Url[] | Uuid[], { publicKey, fileName, baseURL, secureSignature, secureExpire, store, signal, onProgress, source, integration, userAgent, retryThrottledRequestMaxTimes, contentType, multipartChunkSize, baseCDN, jsonpCallback, defaultEffects }: FileFromOptions & GroupFromOptions): Promise<UploadcareGroup>;
+declare class UploadClient {
 	private settings;
 	constructor(settings: Settings);
 	updateSettings(newSettings: Settings): void;
@@ -356,5 +403,21 @@ export declare class UploadClient {
 	uploadFile(data: NodeFile | BrowserFile | Url | Uuid, options?: Partial<FileFromOptions>): Promise<UploadcareFile>;
 	uploadFileGroup(data: (NodeFile | BrowserFile)[] | Url[] | Uuid[], options?: Partial<FileFromOptions & GroupFromOptions>): Promise<UploadcareGroup>;
 }
+export { AbortController } from "abort-controller";
+
+export {
+	UploadClient as UploadClient,
+	base as base,
+	fromUrl as fromUrl,
+	fromUrlStatus as fromUrlStatus,
+	group as group,
+	groupInfo as groupInfo,
+	info as info,
+	multipartComplete as multipartComplete,
+	multipartStart as multipartStart,
+	multipartUpload as multipartUpload,
+	uploadFileGroup as uploadFileGroup,
+	uploadFromObject as uploadBase,
+};
 
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uploadcare/upload-client",
-  "version": "2.0.0-alpha.6",
+  "version": "2.0.0",
   "description": "Library for work with Uploadcare Upload API",
   "type": "module",
   "main": "dist/index.cjs",
@@ -21,6 +21,12 @@
       "import": "./dist/index.js"
     }
   },
+  "react-native": {
+    "./lib/request/request.node.js": "./lib/request/request.browser.js",
+    "./lib/tools/getFormData.node.js": "./lib/tools/getFormData.react-native.js",
+    "./lib/tools/sockets.node.js": "./lib/tools/sockets.browser.js",
+    "./lib/uploadFile/prepareChunks.node.js": "./lib/uploadFile/prepareChunks.react-native.js"
+  },
   "scripts": {
     "check-env-vars": "node ./checkvars.js",
     "mock:start": "node --loader ts-node/esm.mjs ./mock-server/server.ts --silent",
@@ -56,47 +62,47 @@
     "cdn"
   ],
   "devDependencies": {
-    "@koa/cors": "3.1.0",
-    "@koa/router": "8.0.8",
     "@rollup/plugin-alias": "^3.1.1",
     "@rollup/plugin-node-resolve": "^8.4.0",
+    "@types/ws": "8.2.0",
+    "dts-bundle-generator": "5.4.0",
+    "prettier": "2.2.1",
+    "rollup": "^2.23.0",
+    "rollup-plugin-typescript2": "^0.27.1",
+    "typescript": "^3.9.7",
+    "@koa/cors": "3.1.0",
+    "@koa/router": "10.0.0",
     "@types/form-data": "2.5.0",
-    "@types/jest": "26.0.9",
-    "@types/koa": "2.11.3",
-    "@types/node": "12.12.54",
+    "@types/jest": "26.0.14",
+    "@types/koa": "2.11.4",
+    "@types/node": "12.12.67",
     "@types/promise": "7.1.30",
-    "@types/ws": "7.2.6",
-    "@typescript-eslint/eslint-plugin": "2.34.0",
-    "@typescript-eslint/parser": "2.34.0",
+    "@typescript-eslint/eslint-plugin": "5.3.1",
+    "@typescript-eslint/parser": "5.3.1",
     "chalk": "4.1.0",
     "data-uri-to-buffer": "3.0.1",
     "dataurl-to-blob": "0.0.1",
     "dotenv": "8.2.0",
-    "dts-bundle-generator": "^5.3.0",
-    "eslint": "7.6.0",
-    "eslint-config-prettier": "6.11.0",
-    "eslint-plugin-prettier": "3.1.4",
-    "jest": "26.2.2",
-    "jest-environment-jsdom": "26.2.0",
-    "jest-websocket-mock": "2.1.0",
+    "eslint": "8.2.0",
+    "eslint-config-prettier": "8.3.0",
+    "eslint-plugin-prettier": "4.0.0",
+    "jest": "26.5.3",
+    "jest-environment-jsdom": "26.5.2",
+    "jest-websocket-mock": "2.2.0",
     "koa": "2.13.0",
     "koa-add-trailing-slashes": "2.0.1",
     "koa-body": "4.2.0",
     "mock-socket": "9.0.3",
-    "prettier": "1.19.1",
-    "prettier-config-standard": "1.0.1",
+    "prettier-config-standard": "4.0.0",
     "rimraf": "3.0.2",
-    "rollup": "^2.23.0",
-    "rollup-plugin-typescript2": "^0.27.1",
-    "shipjs": "0.20.1",
-    "start-server-and-test": "1.11.3",
-    "ts-jest": "26.1.4",
-    "ts-node": "8.10.2",
-    "typescript": "^3.9.7"
+    "shipjs": "0.24.0",
+    "start-server-and-test": "1.11.7",
+    "ts-jest": "26.4.1",
+    "ts-node": "9.1.1"
   },
   "dependencies": {
     "abort-controller": "^3.0.0",
-    "form-data": "^3.0.0",
-    "ws": "^7.2.1"
+    "form-data": "^4.0.0",
+    "ws": "^8.2.3"
   }
 }