@uploadcare/upload-client 4.3.1-alpha.0 → 5.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +15 -1
- package/dist/index.browser.js +182 -151
- package/dist/index.node.js +87 -57
- package/dist/index.react-native.js +182 -151
- package/dist/types.d.ts +32 -17
- package/package.json +4 -4
package/dist/types.d.ts
CHANGED
|
@@ -19,6 +19,10 @@ export declare type GetUserAgentOptions = {
|
|
|
19
19
|
userAgent?: CustomUserAgent | null;
|
|
20
20
|
};
|
|
21
21
|
export declare function getUserAgent({ libraryName, libraryVersion, userAgent, publicKey, integration }: GetUserAgentOptions): string;
|
|
22
|
+
export declare class UploadcareNetworkError extends Error {
|
|
23
|
+
originalProgressEvent: ProgressEvent;
|
|
24
|
+
constructor(progressEvent: ProgressEvent);
|
|
25
|
+
}
|
|
22
26
|
export declare type GeoLocation = {
|
|
23
27
|
latitude: number;
|
|
24
28
|
longitude: number;
|
|
@@ -137,13 +141,14 @@ export declare type BaseOptions = {
|
|
|
137
141
|
integration?: string;
|
|
138
142
|
userAgent?: CustomUserAgent;
|
|
139
143
|
retryThrottledRequestMaxTimes?: number;
|
|
144
|
+
retryNetworkErrorMaxTimes?: number;
|
|
140
145
|
metadata?: Metadata;
|
|
141
146
|
};
|
|
142
147
|
/**
|
|
143
148
|
* Performs file uploading request to Uploadcare Upload API.
|
|
144
149
|
* Can be canceled and has progress.
|
|
145
150
|
*/
|
|
146
|
-
export function base(file: NodeFile | BrowserFile, { publicKey, fileName, contentType, baseURL, secureSignature, secureExpire, store, signal, onProgress, source, integration, userAgent, retryThrottledRequestMaxTimes, metadata }: BaseOptions): Promise<BaseResponse>;
|
|
151
|
+
export function base(file: NodeFile | BrowserFile, { publicKey, fileName, contentType, baseURL, secureSignature, secureExpire, store, signal, onProgress, source, integration, userAgent, retryThrottledRequestMaxTimes, retryNetworkErrorMaxTimes, metadata }: BaseOptions): Promise<BaseResponse>;
|
|
147
152
|
declare enum TypeEnum {
|
|
148
153
|
Token = "token",
|
|
149
154
|
FileInfo = "file_info"
|
|
@@ -171,12 +176,13 @@ export declare type FromUrlOptions = {
|
|
|
171
176
|
integration?: string;
|
|
172
177
|
userAgent?: CustomUserAgent;
|
|
173
178
|
retryThrottledRequestMaxTimes?: number;
|
|
179
|
+
retryNetworkErrorMaxTimes?: number;
|
|
174
180
|
metadata?: Metadata;
|
|
175
181
|
};
|
|
176
182
|
/**
|
|
177
183
|
* Uploading files from URL.
|
|
178
184
|
*/
|
|
179
|
-
export function fromUrl(sourceUrl: Url, { publicKey, baseURL, store, fileName, checkForUrlDuplicates, saveUrlForRecurrentUploads, secureSignature, secureExpire, source, signal, integration, userAgent, retryThrottledRequestMaxTimes, metadata }: FromUrlOptions): Promise<FromUrlSuccessResponse>;
|
|
185
|
+
export function fromUrl(sourceUrl: Url, { publicKey, baseURL, store, fileName, checkForUrlDuplicates, saveUrlForRecurrentUploads, secureSignature, secureExpire, source, signal, integration, userAgent, retryThrottledRequestMaxTimes, retryNetworkErrorMaxTimes, metadata }: FromUrlOptions): Promise<FromUrlSuccessResponse>;
|
|
180
186
|
declare enum Status {
|
|
181
187
|
Unknown = "unknown",
|
|
182
188
|
Waiting = "waiting",
|
|
@@ -212,11 +218,12 @@ export declare type FromUrlStatusOptions = {
|
|
|
212
218
|
integration?: string;
|
|
213
219
|
userAgent?: CustomUserAgent;
|
|
214
220
|
retryThrottledRequestMaxTimes?: number;
|
|
221
|
+
retryNetworkErrorMaxTimes?: number;
|
|
215
222
|
};
|
|
216
223
|
/**
|
|
217
224
|
* Checking upload status and working with file tokens.
|
|
218
225
|
*/
|
|
219
|
-
export function fromUrlStatus(token: Token, { publicKey, baseURL, signal, integration, userAgent, retryThrottledRequestMaxTimes }?: FromUrlStatusOptions): Promise<FromUrlStatusResponse>;
|
|
226
|
+
export function fromUrlStatus(token: Token, { publicKey, baseURL, signal, integration, userAgent, retryThrottledRequestMaxTimes, retryNetworkErrorMaxTimes }?: FromUrlStatusOptions): Promise<FromUrlStatusResponse>;
|
|
220
227
|
export declare type GroupOptions = {
|
|
221
228
|
publicKey: string;
|
|
222
229
|
baseURL?: string;
|
|
@@ -228,11 +235,12 @@ export declare type GroupOptions = {
|
|
|
228
235
|
integration?: string;
|
|
229
236
|
userAgent?: CustomUserAgent;
|
|
230
237
|
retryThrottledRequestMaxTimes?: number;
|
|
238
|
+
retryNetworkErrorMaxTimes?: number;
|
|
231
239
|
};
|
|
232
240
|
/**
|
|
233
241
|
* Create files group.
|
|
234
242
|
*/
|
|
235
|
-
export function group(uuids: Uuid[], { publicKey, baseURL, jsonpCallback, secureSignature, secureExpire, signal, source, integration, userAgent, retryThrottledRequestMaxTimes }: GroupOptions): Promise<GroupInfo>;
|
|
243
|
+
export function group(uuids: Uuid[], { publicKey, baseURL, jsonpCallback, secureSignature, secureExpire, signal, source, integration, userAgent, retryThrottledRequestMaxTimes, retryNetworkErrorMaxTimes }: GroupOptions): Promise<GroupInfo>;
|
|
236
244
|
export declare type GroupInfoOptions = {
|
|
237
245
|
publicKey: string;
|
|
238
246
|
baseURL?: string;
|
|
@@ -241,11 +249,12 @@ export declare type GroupInfoOptions = {
|
|
|
241
249
|
integration?: string;
|
|
242
250
|
userAgent?: CustomUserAgent;
|
|
243
251
|
retryThrottledRequestMaxTimes?: number;
|
|
252
|
+
retryNetworkErrorMaxTimes?: number;
|
|
244
253
|
};
|
|
245
254
|
/**
|
|
246
255
|
* Get info about group.
|
|
247
256
|
*/
|
|
248
|
-
export function groupInfo(id: GroupId, { publicKey, baseURL, signal, source, integration, userAgent, retryThrottledRequestMaxTimes }: GroupInfoOptions): Promise<GroupInfo>;
|
|
257
|
+
export function groupInfo(id: GroupId, { publicKey, baseURL, signal, source, integration, userAgent, retryThrottledRequestMaxTimes, retryNetworkErrorMaxTimes }: GroupInfoOptions): Promise<GroupInfo>;
|
|
249
258
|
export declare type InfoOptions = {
|
|
250
259
|
publicKey: string;
|
|
251
260
|
baseURL?: string;
|
|
@@ -254,11 +263,12 @@ export declare type InfoOptions = {
|
|
|
254
263
|
integration?: string;
|
|
255
264
|
userAgent?: CustomUserAgent;
|
|
256
265
|
retryThrottledRequestMaxTimes?: number;
|
|
266
|
+
retryNetworkErrorMaxTimes?: number;
|
|
257
267
|
};
|
|
258
268
|
/**
|
|
259
269
|
* Returns a JSON dictionary holding file info.
|
|
260
270
|
*/
|
|
261
|
-
export function info(uuid: Uuid, { publicKey, baseURL, signal, source, integration, userAgent, retryThrottledRequestMaxTimes }: InfoOptions): Promise<FileInfo>;
|
|
271
|
+
export function info(uuid: Uuid, { publicKey, baseURL, signal, source, integration, userAgent, retryThrottledRequestMaxTimes, retryNetworkErrorMaxTimes }: InfoOptions): Promise<FileInfo>;
|
|
262
272
|
export declare type MultipartStartOptions = {
|
|
263
273
|
publicKey: string;
|
|
264
274
|
contentType?: string;
|
|
@@ -273,6 +283,7 @@ export declare type MultipartStartOptions = {
|
|
|
273
283
|
integration?: string;
|
|
274
284
|
userAgent?: CustomUserAgent;
|
|
275
285
|
retryThrottledRequestMaxTimes?: number;
|
|
286
|
+
retryNetworkErrorMaxTimes?: number;
|
|
276
287
|
metadata?: Metadata;
|
|
277
288
|
};
|
|
278
289
|
export declare type MultipartPart = string;
|
|
@@ -283,13 +294,14 @@ export declare type MultipartStartResponse = {
|
|
|
283
294
|
/**
|
|
284
295
|
* Start multipart uploading.
|
|
285
296
|
*/
|
|
286
|
-
export function multipartStart(size: number, { publicKey, contentType, fileName, multipartChunkSize, baseURL, secureSignature, secureExpire, store, signal, source, integration, userAgent, retryThrottledRequestMaxTimes, metadata }: MultipartStartOptions): Promise<MultipartStartResponse>;
|
|
297
|
+
export function multipartStart(size: number, { publicKey, contentType, fileName, multipartChunkSize, baseURL, secureSignature, secureExpire, store, signal, source, integration, userAgent, retryThrottledRequestMaxTimes, retryNetworkErrorMaxTimes, metadata }: MultipartStartOptions): Promise<MultipartStartResponse>;
|
|
287
298
|
export declare type MultipartUploadOptions = {
|
|
288
299
|
publicKey?: string;
|
|
289
300
|
signal?: AbortSignal;
|
|
290
301
|
onProgress?: ProgressCallback<ComputableProgressInfo>;
|
|
291
302
|
integration?: string;
|
|
292
303
|
retryThrottledRequestMaxTimes?: number;
|
|
304
|
+
retryNetworkErrorMaxTimes?: number;
|
|
293
305
|
};
|
|
294
306
|
export declare type MultipartUploadResponse = {
|
|
295
307
|
code?: number;
|
|
@@ -297,7 +309,7 @@ export declare type MultipartUploadResponse = {
|
|
|
297
309
|
/**
|
|
298
310
|
* Complete multipart uploading.
|
|
299
311
|
*/
|
|
300
|
-
export function multipartUpload(part: NodeFile | BrowserFile, url: MultipartPart, { signal, onProgress }: MultipartUploadOptions): Promise<MultipartUploadResponse>;
|
|
312
|
+
export function multipartUpload(part: NodeFile | BrowserFile, url: MultipartPart, { signal, onProgress, retryThrottledRequestMaxTimes, retryNetworkErrorMaxTimes }: MultipartUploadOptions): Promise<MultipartUploadResponse>;
|
|
301
313
|
export declare type MultipartCompleteOptions = {
|
|
302
314
|
publicKey: string;
|
|
303
315
|
baseURL?: string;
|
|
@@ -306,11 +318,12 @@ export declare type MultipartCompleteOptions = {
|
|
|
306
318
|
integration?: string;
|
|
307
319
|
userAgent?: CustomUserAgent;
|
|
308
320
|
retryThrottledRequestMaxTimes?: number;
|
|
321
|
+
retryNetworkErrorMaxTimes?: number;
|
|
309
322
|
};
|
|
310
323
|
/**
|
|
311
324
|
* Complete multipart uploading.
|
|
312
325
|
*/
|
|
313
|
-
export function multipartComplete(uuid: Uuid, { publicKey, baseURL, source, signal, integration, userAgent, retryThrottledRequestMaxTimes }: MultipartCompleteOptions): Promise<FileInfo>;
|
|
326
|
+
export function multipartComplete(uuid: Uuid, { publicKey, baseURL, source, signal, integration, userAgent, retryThrottledRequestMaxTimes, retryNetworkErrorMaxTimes }: MultipartCompleteOptions): Promise<FileInfo>;
|
|
314
327
|
export declare class UploadcareFile {
|
|
315
328
|
readonly uuid: Uuid;
|
|
316
329
|
readonly name: null | string;
|
|
@@ -345,10 +358,11 @@ export declare type DirectOptions = {
|
|
|
345
358
|
integration?: string;
|
|
346
359
|
userAgent?: CustomUserAgent;
|
|
347
360
|
retryThrottledRequestMaxTimes?: number;
|
|
361
|
+
retryNetworkErrorMaxTimes?: number;
|
|
348
362
|
baseCDN?: string;
|
|
349
363
|
metadata?: Metadata;
|
|
350
364
|
};
|
|
351
|
-
export declare const uploadDirect: (file: NodeFile | BrowserFile, { publicKey, fileName, baseURL, secureSignature, secureExpire, store, contentType, signal, onProgress, source, integration, userAgent, retryThrottledRequestMaxTimes, baseCDN, metadata }: DirectOptions) => Promise<UploadcareFile>;
|
|
365
|
+
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>;
|
|
352
366
|
export declare type UploadFromUrlOptions = {
|
|
353
367
|
baseCDN?: string;
|
|
354
368
|
onProgress?: ProgressCallback;
|
|
@@ -365,9 +379,10 @@ export declare type FromUploadedOptions = {
|
|
|
365
379
|
integration?: string;
|
|
366
380
|
userAgent?: CustomUserAgent;
|
|
367
381
|
retryThrottledRequestMaxTimes?: number;
|
|
382
|
+
retryNetworkErrorMaxTimes?: number;
|
|
368
383
|
baseCDN?: string;
|
|
369
384
|
};
|
|
370
|
-
export declare const uploadFromUploaded: (uuid: Uuid, { publicKey, fileName, baseURL, signal, onProgress, source, integration, userAgent, retryThrottledRequestMaxTimes, baseCDN }: FromUploadedOptions) => Promise<UploadcareFile>;
|
|
385
|
+
export declare const uploadFromUploaded: (uuid: Uuid, { publicKey, fileName, baseURL, signal, onProgress, source, integration, userAgent, retryThrottledRequestMaxTimes, retryNetworkErrorMaxTimes, baseCDN }: FromUploadedOptions) => Promise<UploadcareFile>;
|
|
371
386
|
export declare type MultipartOptions = {
|
|
372
387
|
publicKey: string;
|
|
373
388
|
contentType?: string;
|
|
@@ -384,12 +399,12 @@ export declare type MultipartOptions = {
|
|
|
384
399
|
integration?: string;
|
|
385
400
|
userAgent?: CustomUserAgent;
|
|
386
401
|
retryThrottledRequestMaxTimes?: number;
|
|
402
|
+
retryNetworkErrorMaxTimes?: number;
|
|
387
403
|
maxConcurrentRequests?: number;
|
|
388
|
-
multipartMaxAttempts?: number;
|
|
389
404
|
baseCDN?: string;
|
|
390
405
|
metadata?: Metadata;
|
|
391
406
|
};
|
|
392
|
-
export declare const uploadMultipart: (file: NodeFile | BrowserFile, { publicKey, fileName, fileSize, baseURL, secureSignature, secureExpire, store, signal, onProgress, source, integration, userAgent, retryThrottledRequestMaxTimes, contentType, multipartChunkSize, maxConcurrentRequests,
|
|
407
|
+
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>;
|
|
393
408
|
export declare type FileFromOptions = {
|
|
394
409
|
publicKey: string;
|
|
395
410
|
fileName?: string;
|
|
@@ -403,10 +418,10 @@ export declare type FileFromOptions = {
|
|
|
403
418
|
integration?: string;
|
|
404
419
|
userAgent?: CustomUserAgent;
|
|
405
420
|
retryThrottledRequestMaxTimes?: number;
|
|
421
|
+
retryNetworkErrorMaxTimes?: number;
|
|
406
422
|
contentType?: string;
|
|
407
423
|
multipartMinFileSize?: number;
|
|
408
424
|
multipartChunkSize?: number;
|
|
409
|
-
multipartMaxAttempts?: number;
|
|
410
425
|
maxConcurrentRequests?: number;
|
|
411
426
|
baseCDN?: string;
|
|
412
427
|
checkForUrlDuplicates?: boolean;
|
|
@@ -417,7 +432,7 @@ export declare type FileFromOptions = {
|
|
|
417
432
|
/**
|
|
418
433
|
* Uploads file from provided data.
|
|
419
434
|
*/
|
|
420
|
-
export declare function uploadFile(data: NodeFile | BrowserFile | Url | Uuid, { publicKey, fileName, baseURL, secureSignature, secureExpire, store, signal, onProgress, source, integration, userAgent, retryThrottledRequestMaxTimes, contentType, multipartMinFileSize, multipartChunkSize,
|
|
435
|
+
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>;
|
|
421
436
|
export declare class UploadcareGroup {
|
|
422
437
|
readonly uuid: GroupId;
|
|
423
438
|
readonly filesCount: string;
|
|
@@ -433,17 +448,17 @@ export declare class UploadcareGroup {
|
|
|
433
448
|
export declare type GroupFromOptions = {
|
|
434
449
|
jsonpCallback?: string;
|
|
435
450
|
};
|
|
436
|
-
export function uploadFileGroup(data: (NodeFile | BrowserFile)[] | Url[] | Uuid[], { publicKey, fileName, baseURL, secureSignature, secureExpire, store, signal, onProgress, source, integration, userAgent, retryThrottledRequestMaxTimes, contentType, multipartChunkSize, baseCDN, jsonpCallback }: FileFromOptions & GroupFromOptions): Promise<UploadcareGroup>;
|
|
451
|
+
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>;
|
|
437
452
|
export interface DefaultSettings {
|
|
438
453
|
baseCDN: string;
|
|
439
454
|
baseURL: string;
|
|
440
455
|
maxContentLength: number;
|
|
441
456
|
retryThrottledRequestMaxTimes: number;
|
|
457
|
+
retryNetworkErrorMaxTimes: number;
|
|
442
458
|
multipartMinFileSize: number;
|
|
443
459
|
multipartChunkSize: number;
|
|
444
460
|
multipartMinLastPartSize: number;
|
|
445
461
|
maxConcurrentRequests: number;
|
|
446
|
-
multipartMaxAttempts: number;
|
|
447
462
|
pollingTimeoutMilliseconds: number;
|
|
448
463
|
pusherKey: string;
|
|
449
464
|
}
|
package/package.json
CHANGED
|
@@ -1,9 +1,8 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@uploadcare/upload-client",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "5.1.0",
|
|
4
4
|
"description": "Library for work with Uploadcare Upload API",
|
|
5
5
|
"type": "module",
|
|
6
|
-
"main": "./dist/index.node.js",
|
|
7
6
|
"module": "./dist/index.node.js",
|
|
8
7
|
"browser": "./dist/index.browser.js",
|
|
9
8
|
"react-native": "./dist/index.react-native.js",
|
|
@@ -11,7 +10,8 @@
|
|
|
11
10
|
"exports": {
|
|
12
11
|
".": {
|
|
13
12
|
"node": "./dist/index.node.js",
|
|
14
|
-
"browser": "./dist/index.browser.js"
|
|
13
|
+
"browser": "./dist/index.browser.js",
|
|
14
|
+
"default": "./dist/index.browser.js"
|
|
15
15
|
}
|
|
16
16
|
},
|
|
17
17
|
"sideEffects": false,
|
|
@@ -65,7 +65,7 @@
|
|
|
65
65
|
"koa-body": "5.0.0",
|
|
66
66
|
"mock-socket": "9.0.3",
|
|
67
67
|
"start-server-and-test": "1.14.0",
|
|
68
|
-
"@uploadcare/api-client-utils": "^
|
|
68
|
+
"@uploadcare/api-client-utils": "^5.1.0",
|
|
69
69
|
"chalk": "^4.1.2"
|
|
70
70
|
},
|
|
71
71
|
"dependencies": {
|