@uploadcare/upload-client 2.0.0-alpha.8 → 2.2.0

package/README.md

@@ -42,7 +42,7 @@ providing the necessary settings. Specifying `YOUR_PUBLIC_KEY` is mandatory: it
 points to the specific Uploadcare project:
 
 ```javascript
-import UploadClient from '@uploadcare/upload-client'
+import { UploadClient } from '@uploadcare/upload-client'
 
 const client = new UploadClient({ publicKey: 'YOUR_PUBLIC_KEY' })
 ```
@@ -94,10 +94,10 @@ You can cancel file uploading and track this event:
 
 ```javascript
 const fileUUID = 'edfdf045-34c0-4087-bbdd-e3834921f890'
-const controller = new CancelController()
+const abortController = new AbortController()
 
 client
-  .uploadFile(fileUUID, { cancel: controller })
+  .uploadFile(fileUUID, { signal: abortController })
   .then(file => console.log(file.uuid))
   .catch(error => {
     if (error.isCancel) {
@@ -106,7 +106,7 @@ client
   })
 
 // Cancel uploading
-controller.cancel()
+abortController.abort()
 ```
 
 List of all available `UploadClient` API methods:
@@ -163,17 +163,30 @@ interface UploadClient {
 }
 ```
 
+You can import only needed methods directly, without `UploadClient` wrapper:
+
+```javascript
+import {
+  uploadFile,
+  uploadFromUrl,
+  uploadBase,
+  uploadFromUploaded,
+  uploadMultipart,
+  uploadFileGroup
+} from '@uploadcare/upload-client'
+```
+
 ### Low-Level API
 
 Also, you can use low-level wrappers to call the API endpoints directly:
 
 ```javascript
-import { base, CancelController } from '@uploadcare/upload-client'
+import { base, AbortController } from '@uploadcare/upload-client'
 
 const onProgress = ({ value }) => console.log(value)
-const cancelController = new CancelController()
+const abortController = new AbortController()
 
-base(fileData, { onProgress, cancel: cancelController }) // fileData must be `Blob` or `File` or `Buffer`
+base(fileData, { onProgress, signal: abortController }) // fileData must be `Blob` or `File` or `Buffer`
   .then(data => console.log(data.file))
   .catch(error => {
     if (error.isCancel) {
@@ -182,7 +195,7 @@ base(fileData, { onProgress, cancel: cancelController }) // fileData must be `Bl
   })
 
 // Also you can cancel upload:
-cancelController.cancel()
+abortController.abort()
 ```
 
 List of all available API methods:
@@ -290,7 +303,19 @@ of `API secret key` and `secureExpire`.
 
 Stands for the Unix time to which the signature is valid, e.g., `1454902434`.
 
-#### `integration: string`
+#### `integration: string | CustomUserAgentFn`
+
+```typescript
+type CustomUserAgentOptions = {
+  publicKey: string
+  libraryName: string
+  libraryVersion: string
+  languageName: string
+  integration?: string
+}
+
+type CustomUserAgentFn = (options: CustomUserAgentOptions) => string
+```
 
 `X-UC-User-Agent` header value.
 
@@ -372,7 +397,7 @@ npm run test
 By default, tests runs with mock server, but you can run tests with
 production environment.
 
-Run test on production servers: 
+Run test on production servers:
 
 ```bash
 npm run test:production

package/dist/index.browser.cjs

@@ -52,10 +52,11 @@ function __spreadArrays() {
 
 var UploadClientError = /** @class */ (function (_super) {
     __extends(UploadClientError, _super);
-    function UploadClientError(message, request, response, headers) {
+    function UploadClientError(message, code, request, response, headers) {
         var _this = _super.call(this) || this;
         _this.name = 'UploadClientError';
         _this.message = message;
+        _this.code = code;
         _this.request = request;
         _this.response = response;
         _this.headers = headers;
@@ -163,20 +164,27 @@ var request = function (_a) {
     });
 };
 
+function identity(obj) {
+    return obj;
+}
+
+var transformFile = identity;
 var getFormData = (function () { return new FormData(); });
 
+var isFileTuple = function (tuple) {
+    return tuple[0] === 'file';
+};
 function buildFormData(body) {
     var formData = getFormData();
-    var isTriple = function (tuple) {
-        return tuple[0] === 'file';
-    };
     var _loop_1 = function (tuple) {
         if (Array.isArray(tuple[1])) {
             // refactor this
             tuple[1].forEach(function (val) { return val && formData.append(tuple[0] + '[]', "" + val); });
         }
-        else if (isTriple(tuple)) {
-            formData.append(tuple[0], tuple[1], tuple[2]);
+        else if (isFileTuple(tuple)) {
+            var name_1 = tuple[2];
+            var file = transformFile(tuple[1]); // lgtm[js/superfluous-trailing-arguments]
+            formData.append(tuple[0], file, name_1);
         }
         else if (tuple[1] != null) {
             formData.append(tuple[0], "" + tuple[1]);
@@ -234,7 +242,7 @@ var defaultSettings = {
 var defaultContentType = 'application/octet-stream';
 var defaultFilename = 'original';
 
-var version = '1.1.2';
+var version = '2.2.0';
 
 /**
  * Returns User Agent based on version and settings.
@@ -323,7 +331,7 @@ function retrier(fn, options) {
     return runAttempt(fn);
 }
 
-var REQUEST_WAS_THROTTLED_CODE = 429;
+var REQUEST_WAS_THROTTLED_CODE = 'RequestThrottledError';
 var DEFAULT_RETRY_AFTER_TIMEOUT = 15000;
 function getTimeoutFromThrottledRequest(error) {
     var headers = (error || {}).headers;
@@ -335,9 +343,8 @@ function retryIfThrottled(fn, retryThrottledMaxTimes) {
     return retrier(function (_a) {
         var attempt = _a.attempt, retry = _a.retry;
         return fn().catch(function (error) {
-            var _a;
             if ('response' in error &&
-                ((_a = error === null || error === void 0 ? void 0 : error.response) === null || _a === void 0 ? void 0 : _a.statusCode) === REQUEST_WAS_THROTTLED_CODE &&
+                (error === null || error === void 0 ? void 0 : error.code) === REQUEST_WAS_THROTTLED_CODE &&
                 attempt < retryThrottledMaxTimes) {
                 return retry(getTimeoutFromThrottledRequest(error));
             }
@@ -379,7 +386,7 @@ function base(file, _a) {
             var data = _a.data, headers = _a.headers, request = _a.request;
             var response = camelizeKeys(JSON.parse(data));
             if ('error' in response) {
-                throw new UploadClientError("[" + response.error.statusCode + "] " + response.error.content, request, response.error, headers);
+                throw new UploadClientError(response.error.content, response.error.errorCode, request, response, headers);
             }
             else {
                 return response;
@@ -396,7 +403,6 @@ var TypeEnum;
 /**
  * Uploading files from URL.
  */
-/* eslint @typescript-eslint/camelcase: [2, {allow: ["pub_key", "source_url", "check_URL_duplicates", "save_URL_duplicates"]}] */
 function fromUrl(sourceUrl, _a) {
     var publicKey = _a.publicKey, _b = _a.baseURL, baseURL = _b === void 0 ? defaultSettings.baseURL : _b, store = _a.store, fileName = _a.fileName, checkForUrlDuplicates = _a.checkForUrlDuplicates, saveUrlForRecurrentUploads = _a.saveUrlForRecurrentUploads, secureSignature = _a.secureSignature, secureExpire = _a.secureExpire, _c = _a.source, source = _c === void 0 ? 'url' : _c, signal = _a.signal, integration = _a.integration, userAgent = _a.userAgent, _d = _a.retryThrottledRequestMaxTimes, retryThrottledRequestMaxTimes = _d === void 0 ? defaultSettings.retryThrottledRequestMaxTimes : _d;
     return retryIfThrottled(function () {
@@ -422,7 +428,7 @@ function fromUrl(sourceUrl, _a) {
             var data = _a.data, headers = _a.headers, request = _a.request;
             var response = camelizeKeys(JSON.parse(data));
             if ('error' in response) {
-                throw new UploadClientError("[" + response.error.statusCode + "] " + response.error.content, request, response.error, headers);
+                throw new UploadClientError(response.error.content, response.error.errorCode, request, response, headers);
             }
             else {
                 return response;
@@ -468,7 +474,7 @@ function fromUrlStatus(token, _a) {
             var data = _a.data, headers = _a.headers, request = _a.request;
             var response = camelizeKeys(JSON.parse(data));
             if ('error' in response && !isErrorResponse(response)) {
-                throw new UploadClientError("[" + response.error.statusCode + "] " + response.error.content, request, response.error, headers);
+                throw new UploadClientError(response.error.content, undefined, request, response, headers);
             }
             else {
                 return response;
@@ -480,7 +486,6 @@ function fromUrlStatus(token, _a) {
 /**
  * Create files group.
  */
-/* eslint @typescript-eslint/camelcase: [2, {allow: ["pub_key"]}] */
 function group(uuids, _a) {
     var publicKey = _a.publicKey, _b = _a.baseURL, baseURL = _b === void 0 ? defaultSettings.baseURL : _b, jsonpCallback = _a.jsonpCallback, secureSignature = _a.secureSignature, secureExpire = _a.secureExpire, signal = _a.signal, source = _a.source, integration = _a.integration, userAgent = _a.userAgent, _c = _a.retryThrottledRequestMaxTimes, retryThrottledRequestMaxTimes = _c === void 0 ? defaultSettings.retryThrottledRequestMaxTimes : _c;
     return retryIfThrottled(function () {
@@ -503,7 +508,7 @@ function group(uuids, _a) {
             var data = _a.data, headers = _a.headers, request = _a.request;
             var response = camelizeKeys(JSON.parse(data));
             if ('error' in response) {
-                throw new UploadClientError("[" + response.error.statusCode + "] " + response.error.content, request, response.error, headers);
+                throw new UploadClientError(response.error.content, response.error.errorCode, request, response, headers);
             }
             else {
                 return response;
@@ -515,7 +520,6 @@ function group(uuids, _a) {
 /**
  * Get info about group.
  */
-/* eslint @typescript-eslint/camelcase: [2, {allow: ["pub_key", "group_id"]}] */
 function groupInfo(id, _a) {
     var publicKey = _a.publicKey, _b = _a.baseURL, baseURL = _b === void 0 ? defaultSettings.baseURL : _b, signal = _a.signal, source = _a.source, integration = _a.integration, userAgent = _a.userAgent, _c = _a.retryThrottledRequestMaxTimes, retryThrottledRequestMaxTimes = _c === void 0 ? defaultSettings.retryThrottledRequestMaxTimes : _c;
     return retryIfThrottled(function () {
@@ -535,7 +539,7 @@ function groupInfo(id, _a) {
             var data = _a.data, headers = _a.headers, request = _a.request;
             var response = camelizeKeys(JSON.parse(data));
             if ('error' in response) {
-                throw new UploadClientError("[" + response.error.statusCode + "] " + response.error.content, request, response.error, headers);
+                throw new UploadClientError(response.error.content, response.error.errorCode, request, response, headers);
             }
             else {
                 return response;
@@ -547,7 +551,6 @@ function groupInfo(id, _a) {
 /**
  * Returns a JSON dictionary holding file info.
  */
-/* eslint @typescript-eslint/camelcase: [2, {allow: ["pub_key", "file_id"]}] */
 function info(uuid, _a) {
     var publicKey = _a.publicKey, _b = _a.baseURL, baseURL = _b === void 0 ? defaultSettings.baseURL : _b, signal = _a.signal, source = _a.source, integration = _a.integration, userAgent = _a.userAgent, _c = _a.retryThrottledRequestMaxTimes, retryThrottledRequestMaxTimes = _c === void 0 ? defaultSettings.retryThrottledRequestMaxTimes : _c;
     return retryIfThrottled(function () {
@@ -567,7 +570,7 @@ function info(uuid, _a) {
             var data = _a.data, headers = _a.headers, request = _a.request;
             var response = camelizeKeys(JSON.parse(data));
             if ('error' in response) {
-                throw new UploadClientError("[" + response.error.statusCode + "] " + response.error.content, request, response.error, headers);
+                throw new UploadClientError(response.error.content, response.error.errorCode, request, response, headers);
             }
             else {
                 return response;
@@ -604,7 +607,7 @@ function multipartStart(size, _a) {
             var data = _a.data, headers = _a.headers, request = _a.request;
             var response = camelizeKeys(JSON.parse(data));
             if ('error' in response) {
-                throw new UploadClientError("[" + response.error.statusCode + "] " + response.error.content, request, response.error, headers);
+                throw new UploadClientError(response.error.content, response.error.errorCode, request, response, headers);
             }
             else {
                 // convert to array
@@ -661,7 +664,7 @@ function multipartComplete(uuid, _a) {
             var data = _a.data, headers = _a.headers, request = _a.request;
             var response = camelizeKeys(JSON.parse(data));
             if ('error' in response) {
-                throw new UploadClientError("[" + response.error.statusCode + "] " + response.error.content, request, response.error, headers);
+                throw new UploadClientError(response.error.content, response.error.errorCode, request, response, headers);
             }
             else {
                 return response;
@@ -677,6 +680,7 @@ var UploadcareFile = /** @class */ (function () {
         this.size = null;
         this.isStored = null;
         this.isImage = null;
+        this.mimeType = null;
         this.cdnUrl = null;
         this.cdnUrlModifiers = null;
         this.originalUrl = null;
@@ -695,6 +699,7 @@ var UploadcareFile = /** @class */ (function () {
         this.size = fileInfo.size;
         this.isStored = fileInfo.isStored;
         this.isImage = fileInfo.isImage;
+        this.mimeType = fileInfo.mimeType;
         this.cdnUrl = cdnUrl;
         this.cdnUrlModifiers = cdnUrlModifiers;
         this.originalUrl = originalUrl;
@@ -895,7 +900,7 @@ var Pusher = /** @class */ (function () {
                 _this.queue = [];
             });
             this.ws.addEventListener('message', function (e) {
-                var data = JSON.parse(e.data);
+                var data = JSON.parse(e.data.toString());
                 switch (data.event) {
                     case 'pusher:connection_established': {
                         _this.emmitter.emit('connected', undefined);
@@ -1004,7 +1009,7 @@ function pollStrategy(_a) {
             }).then(function (response) {
                 switch (response.status) {
                     case Status.Error: {
-                        return new UploadClientError(response.error);
+                        return new UploadClientError(response.error, response.errorCode);
                     }
                     case Status.Waiting: {
                         return false;
@@ -1032,7 +1037,7 @@ function pollStrategy(_a) {
     });
 }
 var pushStrategy = function (_a) {
-    var token = _a.token, pusherKey = _a.pusherKey, signal = _a.signal, stopRace = _a.stopRace, onProgress = _a.onProgress;
+    var token = _a.token, pusherKey = _a.pusherKey, signal = _a.signal, onProgress = _a.onProgress;
     return new Promise(function (resolve, reject) {
         var pusher = getPusher(pusherKey);
         var unsubErrorHandler = pusher.onError(reject);
@@ -1042,10 +1047,9 @@ var pushStrategy = function (_a) {
         };
         onCancel(signal, function () {
             destroy();
-            reject(cancelError('pisher cancelled'));
+            reject(cancelError('pusher cancelled'));
         });
         pusher.subscribe(token, function (result) {
-            stopRace();
             switch (result.status) {
                 case Status.Progress: {
                     if (onProgress) {
@@ -1062,7 +1066,7 @@ var pushStrategy = function (_a) {
                 }
                 case Status.Error: {
                     destroy();
-                    reject(new UploadClientError(result.msg));
+                    reject(new UploadClientError(result.msg, result.error_code));
                 }
             }
         });
@@ -1087,6 +1091,11 @@ var uploadFromUrl = function (sourceUrl, _a) {
             userAgent: userAgent,
             retryThrottledRequestMaxTimes: retryThrottledRequestMaxTimes
         });
+    })
+        .catch(function (error) {
+        var pusher = getPusher(pusherKey);
+        pusher === null || pusher === void 0 ? void 0 : pusher.disconnect();
+        return Promise.reject(error);
     })
         .then(function (urlResponse) {
         if (urlResponse.type === TypeEnum.FileInfo) {
@@ -1108,11 +1117,10 @@ var uploadFromUrl = function (sourceUrl, _a) {
                     });
                 },
                 function (_a) {
-                    var stopRace = _a.stopRace, signal = _a.signal;
+                    var signal = _a.signal;
                     return pushStrategy({
                         token: urlResponse.token,
                         pusherKey: pusherKey,
-                        stopRace: stopRace,
                         signal: signal,
                         onProgress: onProgress
                     });
@@ -1202,6 +1210,18 @@ var isMultipart = function (fileSize, multipartMinFileSize) {
     return fileSize >= multipartMinFileSize;
 };
 
+var sliceChunk = function (file, index, fileSize, chunkSize) {
+    var start = chunkSize * index;
+    var end = Math.min(start + chunkSize, fileSize);
+    return file.slice(start, end);
+};
+
+function prepareChunks(file, fileSize, chunkSize) {
+    return function (index) {
+        return sliceChunk(file, index, fileSize, chunkSize);
+    };
+}
+
 var runWithConcurrency = function (concurrency, tasks) {
     return new Promise(function (resolve, reject) {
         var results = [];
@@ -1237,18 +1257,15 @@ var runWithConcurrency = function (concurrency, tasks) {
     });
 };
 
-var getChunk = function (file, index, fileSize, chunkSize) {
-    var start = chunkSize * index;
-    var end = Math.min(start + chunkSize, fileSize);
-    return file.slice(start, end);
-};
 var uploadPartWithRetry = function (chunk, url, _a) {
-    var onProgress = _a.onProgress, signal = _a.signal, multipartMaxAttempts = _a.multipartMaxAttempts;
+    var publicKey = _a.publicKey, onProgress = _a.onProgress, signal = _a.signal, integration = _a.integration, multipartMaxAttempts = _a.multipartMaxAttempts;
     return retrier(function (_a) {
         var attempt = _a.attempt, retry = _a.retry;
         return multipartUpload(chunk, url, {
+            publicKey: publicKey,
             onProgress: onProgress,
-            signal: signal
+            signal: signal,
+            integration: integration
         }).catch(function (error) {
             if (attempt < multipartMaxAttempts) {
                 return retry();
@@ -1292,12 +1309,15 @@ var uploadMultipart = function (file, _a) {
     })
         .then(function (_a) {
         var uuid = _a.uuid, parts = _a.parts;
+        var getChunk = prepareChunks(file, size, multipartChunkSize);
         return Promise.all([
             uuid,
             runWithConcurrency(maxConcurrentRequests, parts.map(function (url, index) { return function () {
-                return uploadPartWithRetry(getChunk(file, index, size, multipartChunkSize), url, {
+                return uploadPartWithRetry(getChunk(index), url, {
+                    publicKey: publicKey,
                     onProgress: createProgressHandler(parts.length, index),
                     signal: signal,
+                    integration: integration,
                     multipartMaxAttempts: multipartMaxAttempts
                 });
             }; }))
@@ -1339,7 +1359,7 @@ var uploadMultipart = function (file, _a) {
  * Uploads file from provided data.
  */
 function uploadFile(data, _a) {
-    var publicKey = _a.publicKey, fileName = _a.fileName, _b = _a.baseURL, baseURL = _b === void 0 ? defaultSettings.baseURL : _b, secureSignature = _a.secureSignature, secureExpire = _a.secureExpire, store = _a.store, signal = _a.signal, onProgress = _a.onProgress, source = _a.source, integration = _a.integration, userAgent = _a.userAgent, retryThrottledRequestMaxTimes = _a.retryThrottledRequestMaxTimes, contentType = _a.contentType, _c = _a.multipartChunkSize, multipartChunkSize = _c === void 0 ? defaultSettings.multipartChunkSize : _c, _d = _a.baseCDN, baseCDN = _d === void 0 ? defaultSettings.baseCDN : _d;
+    var publicKey = _a.publicKey, fileName = _a.fileName, _b = _a.baseURL, baseURL = _b === void 0 ? defaultSettings.baseURL : _b, secureSignature = _a.secureSignature, secureExpire = _a.secureExpire, store = _a.store, signal = _a.signal, onProgress = _a.onProgress, source = _a.source, integration = _a.integration, userAgent = _a.userAgent, retryThrottledRequestMaxTimes = _a.retryThrottledRequestMaxTimes, contentType = _a.contentType, multipartChunkSize = _a.multipartChunkSize, multipartMaxAttempts = _a.multipartMaxAttempts, maxConcurrentRequests = _a.maxConcurrentRequests, _c = _a.baseCDN, baseCDN = _c === void 0 ? defaultSettings.baseCDN : _c, checkForUrlDuplicates = _a.checkForUrlDuplicates, saveUrlForRecurrentUploads = _a.saveUrlForRecurrentUploads, pusherKey = _a.pusherKey;
     if (isFileData(data)) {
         var fileSize = getFileSize(data);
         if (isMultipart(fileSize)) {
@@ -1347,6 +1367,7 @@ function uploadFile(data, _a) {
                 publicKey: publicKey,
                 contentType: contentType,
                 multipartChunkSize: multipartChunkSize,
+                multipartMaxAttempts: multipartMaxAttempts,
                 fileName: fileName,
                 baseURL: baseURL,
                 secureSignature: secureSignature,
@@ -1357,6 +1378,7 @@ function uploadFile(data, _a) {
                 source: source,
                 integration: integration,
                 userAgent: userAgent,
+                maxConcurrentRequests: maxConcurrentRequests,
                 retryThrottledRequestMaxTimes: retryThrottledRequestMaxTimes,
                 baseCDN: baseCDN
             });
@@ -1382,6 +1404,9 @@ function uploadFile(data, _a) {
             publicKey: publicKey,
             fileName: fileName,
             baseURL: baseURL,
+            baseCDN: baseCDN,
+            checkForUrlDuplicates: checkForUrlDuplicates,
+            saveUrlForRecurrentUploads: saveUrlForRecurrentUploads,
             secureSignature: secureSignature,
             secureExpire: secureExpire,
             store: store,
@@ -1391,7 +1416,7 @@ function uploadFile(data, _a) {
             integration: integration,
             userAgent: userAgent,
             retryThrottledRequestMaxTimes: retryThrottledRequestMaxTimes,
-            baseCDN: baseCDN
+            pusherKey: pusherKey
         });
     }
     if (isUuid(data)) {
@@ -1418,8 +1443,7 @@ var UploadcareGroup = /** @class */ (function () {
         this.filesCount = groupInfo.filesCount;
         this.totalSize = Object.values(groupInfo.files).reduce(function (acc, file) { return acc + file.size; }, 0);
         this.isStored = !!groupInfo.datetimeStored;
-        this.isImage = !!Object.values(groupInfo.files).filter(function (file) { return file.isImage; })
-            .length;
+        this.isImage = !!Object.values(groupInfo.files).filter(function (file) { return file.isImage; }).length;
         this.cdnUrl = groupInfo.cdnUrl;
         this.files = files;
         this.createdAt = groupInfo.datetimeCreated;
@@ -1592,6 +1616,9 @@ var UploadClient = /** @class */ (function () {
 
 exports.AbortController = AbortController;
 exports.UploadClient = UploadClient;
+exports.UploadClientError = UploadClientError;
+exports.UploadcareFile = UploadcareFile;
+exports.UploadcareGroup = UploadcareGroup;
 exports.base = base;
 exports.fromUrl = fromUrl;
 exports.fromUrlStatus = fromUrlStatus;
@@ -1601,5 +1628,9 @@ exports.info = info;
 exports.multipartComplete = multipartComplete;
 exports.multipartStart = multipartStart;
 exports.multipartUpload = multipartUpload;
+exports.uploadBase = uploadFromObject;
 exports.uploadFile = uploadFile;
 exports.uploadFileGroup = uploadFileGroup;
+exports.uploadFromUploaded = uploadFromUploaded;
+exports.uploadFromUrl = uploadFromUrl;
+exports.uploadMultipart = uploadMultipart;