@uploadcare/upload-client 2.2.1-alpha.0 → 3.1.0

package/dist/types.d.ts

@@ -41,6 +41,17 @@ export declare type VideoInfo = {
 		codec: string;
 	};
 };
+export declare type ContentInfo = {
+	content_info: {
+		mime?: {
+			mime: string;
+			type: string;
+			subtype: string;
+		};
+		image?: ImageInfo;
+		video?: VideoInfo;
+	};
+};
 export declare type FileInfo = {
 	size: number;
 	done: number;
@@ -55,7 +66,9 @@ export declare type FileInfo = {
 	isReady: string;
 	imageInfo: ImageInfo | null;
 	videoInfo: VideoInfo | null;
-	s3Bucket: string | null;
+	contentInfo: ContentInfo | null;
+	s3Bucket?: string;
+	metadata?: Metadata;
 };
 export declare type GroupInfo = {
 	datetimeCreated: string;
@@ -70,9 +83,17 @@ export declare type Token = string;
 export declare type Uuid = string;
 export declare type GroupId = string;
 export declare type Url = string;
-export declare type ProgressCallback = (arg: {
+export declare type ComputableProgressInfo = {
+	isComputable: true;
 	value: number;
-}) => void;
+};
+export declare type UnknownProgressInfo = {
+	isComputable: false;
+};
+export declare type ProgressCallback<T = ComputableProgressInfo | UnknownProgressInfo> = (arg: T) => void;
+export declare type Metadata = {
+	[key: string]: string;
+};
 export interface DefaultSettings {
 	baseCDN: string;
 	baseURL: string;
@@ -137,8 +158,9 @@ export declare type BaseOptions = {
 	integration?: string;
 	userAgent?: CustomUserAgent;
 	retryThrottledRequestMaxTimes?: number;
+	metadata?: Metadata;
 };
-declare function base(file: NodeFile | BrowserFile, { publicKey, fileName, baseURL, secureSignature, secureExpire, store, signal, onProgress, source, integration, userAgent, retryThrottledRequestMaxTimes }: BaseOptions): Promise<BaseResponse>;
+declare function base(file: NodeFile | BrowserFile, { publicKey, fileName, baseURL, secureSignature, secureExpire, store, signal, onProgress, source, integration, userAgent, retryThrottledRequestMaxTimes, metadata }: BaseOptions): Promise<BaseResponse>;
 declare enum TypeEnum {
 	Token = "token",
 	FileInfo = "file_info"
@@ -166,8 +188,9 @@ export declare type FromUrlOptions = {
 	integration?: string;
 	userAgent?: CustomUserAgent;
 	retryThrottledRequestMaxTimes?: number;
+	metadata?: Metadata;
 };
-declare function fromUrl(sourceUrl: Url, { publicKey, baseURL, store, fileName, checkForUrlDuplicates, saveUrlForRecurrentUploads, secureSignature, secureExpire, source, signal, integration, userAgent, retryThrottledRequestMaxTimes }: FromUrlOptions): Promise<FromUrlSuccessResponse>;
+declare function fromUrl(sourceUrl: Url, { publicKey, baseURL, store, fileName, checkForUrlDuplicates, saveUrlForRecurrentUploads, secureSignature, secureExpire, source, signal, integration, userAgent, retryThrottledRequestMaxTimes, metadata }: FromUrlOptions): Promise<FromUrlSuccessResponse>;
 declare enum Status {
 	Unknown = "unknown",
 	Waiting = "waiting",
@@ -185,7 +208,7 @@ export declare type StatusProgressResponse = {
 	status: Status.Progress;
 	size: number;
 	done: number;
-	total: number;
+	total: number | "unknown";
 };
 export declare type StatusErrorResponse = {
 	status: Status.Error;
@@ -252,17 +275,18 @@ export declare type MultipartStartOptions = {
 	integration?: string;
 	userAgent?: CustomUserAgent;
 	retryThrottledRequestMaxTimes?: number;
+	metadata?: Metadata;
 };
 export declare type MultipartPart = string;
 export declare type MultipartStartResponse = {
 	parts: MultipartPart[];
 	uuid: Uuid;
 };
-declare function multipartStart(size: number, { publicKey, contentType, fileName, multipartChunkSize, baseURL, secureSignature, secureExpire, store, signal, source, integration, userAgent, retryThrottledRequestMaxTimes }: MultipartStartOptions): Promise<MultipartStartResponse>;
+declare function multipartStart(size: number, { publicKey, contentType, fileName, multipartChunkSize, baseURL, secureSignature, secureExpire, store, signal, source, integration, userAgent, retryThrottledRequestMaxTimes, metadata }: MultipartStartOptions): Promise<MultipartStartResponse>;
 export declare type MultipartUploadOptions = {
 	publicKey?: string;
 	signal?: AbortSignal;
-	onProgress?: ProgressCallback;
+	onProgress?: ProgressCallback<ComputableProgressInfo>;
 	integration?: string;
 	retryThrottledRequestMaxTimes?: number;
 };
@@ -293,6 +317,8 @@ export declare class UploadcareFile {
 	readonly originalFilename: null | string;
 	readonly imageInfo: null | ImageInfo;
 	readonly videoInfo: null | VideoInfo;
+	readonly contentInfo: null | ContentInfo;
+	readonly metadata: null | Metadata;
 	constructor(fileInfo: FileInfo, { baseCDN, defaultEffects, fileName }: {
 		baseCDN?: string;
 		defaultEffects?: string;
@@ -313,14 +339,15 @@ export declare type FromObjectOptions = {
 	userAgent?: CustomUserAgent;
 	retryThrottledRequestMaxTimes?: number;
 	baseCDN?: string;
+	metadata?: Metadata;
 };
-declare const uploadFromObject: (file: NodeFile | BrowserFile, { publicKey, fileName, baseURL, secureSignature, secureExpire, store, signal, onProgress, source, integration, userAgent, retryThrottledRequestMaxTimes, baseCDN }: FromObjectOptions) => Promise<UploadcareFile>;
+declare const uploadFromObject: (file: NodeFile | BrowserFile, { publicKey, fileName, baseURL, secureSignature, secureExpire, store, signal, onProgress, source, integration, userAgent, retryThrottledRequestMaxTimes, baseCDN, metadata }: 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 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 = {
 	publicKey: string;
 	fileName?: string;
@@ -345,7 +372,7 @@ export declare type MultipartOptions = {
 	secureExpire?: string;
 	store?: boolean;
 	signal?: AbortSignal;
-	onProgress?: ProgressCallback;
+	onProgress?: ProgressCallback<ComputableProgressInfo>;
 	source?: string;
 	integration?: string;
 	userAgent?: CustomUserAgent;
@@ -353,8 +380,9 @@ export declare type MultipartOptions = {
 	maxConcurrentRequests?: number;
 	multipartMaxAttempts?: 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, contentType, multipartChunkSize, maxConcurrentRequests, multipartMaxAttempts, baseCDN }: MultipartOptions) => Promise<UploadcareFile>;
+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, metadata }: MultipartOptions) => Promise<UploadcareFile>;
 export declare type FileFromOptions = {
 	publicKey: string;
 	fileName?: string;
@@ -369,6 +397,7 @@ export declare type FileFromOptions = {
 	userAgent?: CustomUserAgent;
 	retryThrottledRequestMaxTimes?: number;
 	contentType?: string;
+	multipartMinFileSize?: number;
 	multipartChunkSize?: number;
 	multipartMaxAttempts?: number;
 	maxConcurrentRequests?: number;
@@ -376,11 +405,12 @@ export declare type FileFromOptions = {
 	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, contentType, multipartChunkSize, multipartMaxAttempts, maxConcurrentRequests, baseCDN, checkForUrlDuplicates, saveUrlForRecurrentUploads, pusherKey }: 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, multipartMinFileSize, multipartChunkSize, multipartMaxAttempts, maxConcurrentRequests, baseCDN, checkForUrlDuplicates, saveUrlForRecurrentUploads, pusherKey, metadata }: FileFromOptions): Promise<UploadcareFile>;
 export declare class UploadcareGroup {
 	readonly uuid: GroupId;
 	readonly filesCount: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uploadcare/upload-client",
-  "version": "2.2.1-alpha.0",
+  "version": "3.1.0",
   "description": "Library for work with Uploadcare Upload API",
   "type": "module",
   "main": "dist/index.cjs",
@@ -22,7 +22,7 @@
   },
   "scripts": {
     "check-env-vars": "node ./checkvars.js",
-    "mock:start": "node --loader ts-node/esm.mjs ./mock-server/server.ts --silent",
+    "mock:start": "node --loader ts-node/esm ./mock-server/server.ts --silent",
     "clean": "rimraf dist",
     "lint": "eslint ./src ./mock-server --ext=ts",
     "test": "start-server-and-test mock:start :3000 test:jest",
@@ -91,7 +91,7 @@
     "shipjs": "0.24.0",
     "start-server-and-test": "1.11.7",
     "ts-jest": "26.4.1",
-    "ts-node": "9.1.1"
+    "ts-node": "10.5.0"
   },
   "dependencies": {
     "abort-controller": "^3.0.0",