@uploadcare/upload-client 4.0.1 → 4.2.1

package/README.md

@@ -1,6 +1,6 @@
 # Uploadcare Upload Client
 
-<a href="https://uploadcare.com/?utm_source=github&utm_campaign=uploadcare-upload-client">
+<a href="https://uploadcare.com/?utm_source=github&utm_campaign=uploadcare-js-api-clients">
     <img align="right" width="64" height="64"
       src="https://ucarecdn.com/edfdf045-34c0-4087-bbdd-e3834921f890/userpiccircletransparent.svg"
       alt="">
@@ -9,6 +9,8 @@
 This is an Uploadcare [Upload API][uc-docs-upload-api] wrapper to work with
 Node.js and browser.
 
+[API Reference](https://uploadcare.github.io/uploadcare-js-api-clients/upload-client/)
+
 [![Build Status][badge-build]][build-url]
 [![NPM version][npm-img]][npm-url]
 [![GitHub release][badge-release-img]][badge-release-url]&nbsp;
@@ -227,11 +229,11 @@ fromUrlStatus(
 ```
 
 ```typescript
-  group(uuids: Uuid[], options: GroupOptions): Promise<GroupInfo>
+group(uuids: Uuid[], options: GroupOptions): Promise<GroupInfo>
 ```
 
 ```typescript
-  groupInfo(id: GroupId, options: GroupInfoOptions): Promise<GroupInfo>
+groupInfo(id: GroupId, options: GroupInfoOptions): Promise<GroupInfo>
 ```
 
 ```typescript
@@ -461,16 +463,16 @@ request at [hello@uploadcare.com][uc-email-hello].
 
 [uc-email-bounty]: mailto:bugbounty@uploadcare.com
 [uc-email-hello]: mailto:hello@uploadcare.com
-[github-releases]: https://github.com/uploadcare/uploadcare-upload-client/releases
-[github-branch-release]: https://github.com/uploadcare/uploadcare-upload-client/tree/release
-[github-contributors]: https://github.com/uploadcare/uploadcare-upload-client/graphs/contributors
+[github-releases]: https://github.com/uploadcare/uploadcare-js-api-clients/releases
+[github-branch-release]: https://github.com/uploadcare/uploadcare-js-api-clients/tree/release
+[github-contributors]: https://github.com/uploadcare/uploadcare-js-api-clients/graphs/contributors
 [badge-stack-img]: https://img.shields.io/badge/tech-stack-0690fa.svg?style=flat
 [badge-stack-url]: https://stackshare.io/uploadcare/stacks/
-[badge-release-img]: https://img.shields.io/github/release/uploadcare/uploadcare-upload-client.svg
-[badge-release-url]: https://github.com/uploadcare/uploadcare-upload-client/releases
+[badge-release-img]: https://img.shields.io/github/release/uploadcare/uploadcare-js-api-clients.svg
+[badge-release-url]: https://github.com/uploadcare/uploadcare-js-api-clients/releases
 [npm-img]: http://img.shields.io/npm/v/@uploadcare/upload-client.svg
 [npm-url]: https://www.npmjs.org/package/@uploadcare/upload-client
-[badge-build]: https://github.com/uploadcare/uploadcare-upload-client/actions/workflows/checks.yml/badge.svg
-[build-url]: https://github.com/uploadcare/uploadcare-upload-client/actions/workflows/checks.yml
-[uc-docs-upload-api]: https://uploadcare.com/docs/api_reference/upload/?utm_source=github&utm_campaign=uploadcare-upload-client
+[badge-build]: https://github.com/uploadcare/uploadcare-js-api-clients/actions/workflows/checks.yml/badge.svg
+[build-url]: https://github.com/uploadcare/uploadcare-js-api-clients/actions/workflows/checks.yml
+[uc-docs-upload-api]: https://uploadcare.com/docs/api_reference/upload/?utm_source=github&utm_campaign=uploadcare-js-api-clients
 [uc-docs-metadata]: https://uploadcare.com/api-refs/rest-api/v0.7.0/#tag/File-Metadata

package/dist/index.browser.js

@@ -29,7 +29,7 @@ const onCancel = (signal, callback) => {
 
 const request = ({ method, url, data, headers = {}, signal, onProgress }) => new Promise((resolve, reject) => {
     const xhr = new XMLHttpRequest();
-    const requestMethod = (method === null || method === void 0 ? void 0 : method.toUpperCase()) || 'GET';
+    const requestMethod = method?.toUpperCase() || 'GET';
     let aborted = false;
     xhr.open(requestMethod, url);
     if (headers) {
@@ -197,34 +197,36 @@ function buildFormData(options) {
     return formData;
 }
 
-const serializePair = (key, value) => typeof value !== 'undefined' ? `${key}=${encodeURIComponent(value)}` : null;
-// TODO: generalize value transforming logic and use it here and inside `buildFormData`
-const createQuery = (query) => Object.entries(query)
-    .reduce((params, [key, value]) => {
-    let param;
-    if (typeof value === 'object' && !Array.isArray(value)) {
-        param = Object.entries(value)
-            .filter((entry) => typeof entry[1] !== 'undefined')
-            .map((entry) => serializePair(`${key}[${entry[0]}]`, String(entry[1])));
-    }
-    else if (Array.isArray(value)) {
-        param = value.map((val) => serializePair(`${key}[]`, val));
+const buildSearchParams = (query) => {
+    const searchParams = new URLSearchParams();
+    for (const [key, value] of Object.entries(query)) {
+        if (value && typeof value === 'object' && !Array.isArray(value)) {
+            Object.entries(value)
+                .filter((entry) => entry[1] ?? false)
+                .forEach((entry) => searchParams.set(`${key}[${entry[0]}]`, String(entry[1])));
+        }
+        else if (Array.isArray(value)) {
+            value.forEach((val) => {
+                searchParams.append(`${key}[]`, val);
+            });
+        }
+        else if (typeof value === 'string' && value) {
+            searchParams.set(key, value);
+        }
+        else if (typeof value === 'number') {
+            searchParams.set(key, value.toString());
+        }
     }
-    else {
-        param = serializePair(key, value);
+    return searchParams.toString();
+};
+const getUrl = (base, path, query) => {
+    const url = new URL(base);
+    url.pathname = path;
+    if (query) {
+        url.search = buildSearchParams(query);
     }
-    return params.concat(param);
-}, [])
-    .filter((x) => !!x)
-    .join('&');
-const getUrl = (base, path, query) => [
-    base,
-    path,
-    query && Object.keys(query).length > 0 ? '?' : '',
-    query && createQuery(query)
-]
-    .filter(Boolean)
-    .join('');
+    return url.toString();
+};
 
 /*
   Settings for future support:
@@ -246,14 +248,59 @@ const defaultSettings = {
 const defaultContentType = 'application/octet-stream';
 const defaultFilename = 'original';
 
-var version = '4.0.1';
+var version = '4.2.1';
+
+function isObject(o) {
+    return Object.prototype.toString.call(o) === '[object Object]';
+}
+
+const SEPARATOR = /\W|_/g;
+function camelizeString(text) {
+    return text
+        .split(SEPARATOR)
+        .map((word, index) => word.charAt(0)[index > 0 ? 'toUpperCase' : 'toLowerCase']() +
+        word.slice(1))
+        .join('');
+}
+function camelizeArrayItems(array, { ignoreKeys } = { ignoreKeys: [] }) {
+    if (!Array.isArray(array)) {
+        return array;
+    }
+    return array.map((item) => camelizeKeys(item, { ignoreKeys }));
+}
+function camelizeKeys(source, { ignoreKeys } = { ignoreKeys: [] }) {
+    if (Array.isArray(source)) {
+        return camelizeArrayItems(source, { ignoreKeys });
+    }
+    if (!isObject(source)) {
+        return source;
+    }
+    const result = {};
+    for (const key of Object.keys(source)) {
+        let value = source[key];
+        if (ignoreKeys.includes(key)) {
+            result[key] = value;
+            continue;
+        }
+        if (isObject(value)) {
+            value = camelizeKeys(value, { ignoreKeys });
+        }
+        else if (Array.isArray(value)) {
+            value = camelizeArrayItems(value, { ignoreKeys });
+        }
+        result[camelizeString(key)] = value;
+    }
+    return result;
+}
 
 /**
- * Returns User Agent based on version and settings.
+ * setTimeout as Promise.
+ *
+ * @param {number} ms Timeout in milliseconds.
  */
-function getUserAgent({ userAgent, publicKey = '', integration = '' } = {}) {
-    const libraryName = 'UploadcareUploadClient';
-    const libraryVersion = version;
+const delay = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
+
+function getUserAgent$1({ libraryName, libraryVersion, userAgent, publicKey = '', integration = '' }) {
     const languageName = 'JavaScript';
     if (typeof userAgent === 'string') {
         return userAgent;
@@ -274,39 +321,6 @@ function getUserAgent({ userAgent, publicKey = '', integration = '' } = {}) {
     return `${mainInfo} (${additionInfo})`;
 }
 
-const SEPARATOR = /\W|_/g;
-/**
- * Transforms a string to camelCased.
- */
-function camelize(text) {
-    return text
-        .split(SEPARATOR)
-        .map((word, index) => word.charAt(0)[index > 0 ? 'toUpperCase' : 'toLowerCase']() +
-        word.slice(1))
-        .join('');
-}
-/**
- * Transforms keys of an object to camelCased recursively.
- */
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-function camelizeKeys(source) {
-    if (!source || typeof source !== 'object') {
-        return source;
-    }
-    return Object.keys(source).reduce((accumulator, key) => {
-        accumulator[camelize(key)] =
-            typeof source[key] === 'object' ? camelizeKeys(source[key]) : source[key];
-        return accumulator;
-    }, {});
-}
-
-/**
- * setTimeout as Promise.
- *
- * @param {number} ms Timeout in milliseconds.
- */
-const delay = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
-
 const defaultOptions = {
     factor: 2,
     time: 100
@@ -314,8 +328,8 @@ const defaultOptions = {
 function retrier(fn, options = defaultOptions) {
     let attempts = 0;
     function runAttempt(fn) {
-        const defaultDelayTime = Math.round(options.time * Math.pow(options.factor, attempts));
-        const retry = (ms) => delay(ms !== null && ms !== void 0 ? ms : defaultDelayTime).then(() => {
+        const defaultDelayTime = Math.round(options.time * options.factor ** attempts);
+        const retry = (ms) => delay(ms ?? defaultDelayTime).then(() => {
             attempts += 1;
             return runAttempt(fn);
         });
@@ -327,6 +341,16 @@ function retrier(fn, options = defaultOptions) {
     return runAttempt(fn);
 }
 
+const LIBRARY_NAME = 'UploadcareUploadClient';
+const LIBRARY_VERSION = version;
+function getUserAgent(options) {
+    return getUserAgent$1({
+        libraryName: LIBRARY_NAME,
+        libraryVersion: LIBRARY_VERSION,
+        ...options
+    });
+}
+
 const REQUEST_WAS_THROTTLED_CODE = 'RequestThrottledError';
 const DEFAULT_RETRY_AFTER_TIMEOUT = 15000;
 function getTimeoutFromThrottledRequest(error) {
@@ -338,7 +362,7 @@ function getTimeoutFromThrottledRequest(error) {
 function retryIfThrottled(fn, retryThrottledMaxTimes) {
     return retrier(({ attempt, retry }) => fn().catch((error) => {
         if ('response' in error &&
-            (error === null || error === void 0 ? void 0 : error.code) === REQUEST_WAS_THROTTLED_CODE &&
+            error?.code === REQUEST_WAS_THROTTLED_CODE &&
             attempt < retryThrottledMaxTimes) {
             return retry(getTimeoutFromThrottledRequest(error));
         }
@@ -355,41 +379,38 @@ function getStoreValue(store) {
  * Can be canceled and has progress.
  */
 function base(file, { publicKey, fileName, contentType, baseURL = defaultSettings.baseURL, secureSignature, secureExpire, store, signal, onProgress, source = 'local', integration, userAgent, retryThrottledRequestMaxTimes = defaultSettings.retryThrottledRequestMaxTimes, metadata }) {
-    return retryIfThrottled(() => {
-        var _a;
-        return request({
-            method: 'POST',
-            url: getUrl(baseURL, '/base/', {
-                jsonerrors: 1
-            }),
-            headers: {
-                'X-UC-User-Agent': getUserAgent({ publicKey, integration, userAgent })
+    return retryIfThrottled(() => request({
+        method: 'POST',
+        url: getUrl(baseURL, '/base/', {
+            jsonerrors: 1
+        }),
+        headers: {
+            'X-UC-User-Agent': getUserAgent({ publicKey, integration, userAgent })
+        },
+        data: buildFormData({
+            file: {
+                data: file,
+                name: fileName ?? file.name ?? defaultFilename,
+                contentType
             },
-            data: buildFormData({
-                file: {
-                    data: file,
-                    name: (_a = fileName !== null && fileName !== void 0 ? fileName : file.name) !== null && _a !== void 0 ? _a : defaultFilename,
-                    contentType
-                },
-                UPLOADCARE_PUB_KEY: publicKey,
-                UPLOADCARE_STORE: getStoreValue(store),
-                signature: secureSignature,
-                expire: secureExpire,
-                source: source,
-                metadata
-            }),
-            signal,
-            onProgress
-        }).then(({ data, headers, request }) => {
-            const response = camelizeKeys(JSON.parse(data));
-            if ('error' in response) {
-                throw new UploadClientError(response.error.content, response.error.errorCode, request, response, headers);
-            }
-            else {
-                return response;
-            }
-        });
-    }, retryThrottledRequestMaxTimes);
+            UPLOADCARE_PUB_KEY: publicKey,
+            UPLOADCARE_STORE: getStoreValue(store),
+            signature: secureSignature,
+            expire: secureExpire,
+            source: source,
+            metadata
+        }),
+        signal,
+        onProgress
+    }).then(({ data, headers, request }) => {
+        const response = camelizeKeys(JSON.parse(data));
+        if ('error' in response) {
+            throw new UploadClientError(response.error.content, response.error.errorCode, request, response, headers);
+        }
+        else {
+            return response;
+        }
+    }), retryThrottledRequestMaxTimes);
 }
 
 var TypeEnum;
@@ -568,9 +589,9 @@ function multipartStart(size, { publicKey, contentType, fileName, multipartChunk
             'X-UC-User-Agent': getUserAgent({ publicKey, integration, userAgent })
         },
         data: buildFormData({
-            filename: fileName !== null && fileName !== void 0 ? fileName : defaultFilename,
+            filename: fileName ?? defaultFilename,
             size: size,
-            content_type: contentType !== null && contentType !== void 0 ? contentType : defaultContentType,
+            content_type: contentType ?? defaultContentType,
             part_size: multipartChunkSize,
             UPLOADCARE_STORE: getStoreValue(store),
             UPLOADCARE_PUB_KEY: publicKey,
@@ -672,9 +693,9 @@ class UploadcareFile {
         this.mimeType = fileInfo.mimeType;
         this.cdnUrl = cdnUrl;
         this.originalFilename = fileInfo.originalFilename;
-        this.imageInfo = camelizeKeys(fileInfo.imageInfo);
-        this.videoInfo = camelizeKeys(fileInfo.videoInfo);
-        this.contentInfo = camelizeKeys(fileInfo.contentInfo);
+        this.imageInfo = fileInfo.imageInfo;
+        this.videoInfo = fileInfo.videoInfo;
+        this.contentInfo = fileInfo.contentInfo;
         this.metadata = fileInfo.metadata || null;
         this.s3Bucket = s3Bucket || null;
         this.s3Url = s3Url;
@@ -802,8 +823,7 @@ class Events {
         this.events = Object.create({});
     }
     emit(event, data) {
-        var _a;
-        (_a = this.events[event]) === null || _a === void 0 ? void 0 : _a.forEach((fn) => fn(data));
+        this.events[event]?.forEach((fn) => fn(data));
     }
     on(event, callback) {
         this.events[event] = this.events[event] || [];
@@ -821,12 +841,12 @@ class Events {
 
 const response = (type, data) => {
     if (type === 'success') {
-        return Object.assign({ status: Status.Success }, data);
+        return { status: Status.Success, ...data };
     }
     if (type === 'progress') {
-        return Object.assign({ status: Status.Progress }, data);
+        return { status: Status.Progress, ...data };
     }
-    return Object.assign({ status: Status.Error }, data);
+    return { status: Status.Error, ...data };
 };
 class Pusher {
     constructor(pusherKey, disconnectTime = 30000) {
@@ -874,8 +894,7 @@ class Pusher {
     }
     disconnect() {
         const actualDisconect = () => {
-            var _a;
-            (_a = this.ws) === null || _a === void 0 ? void 0 : _a.close();
+            this.ws?.close();
             this.ws = undefined;
             this.isConnected = false;
         };
@@ -889,9 +908,8 @@ class Pusher {
         }
     }
     send(event, data) {
-        var _a;
         const str = JSON.stringify({ event, data });
-        (_a = this.ws) === null || _a === void 0 ? void 0 : _a.send(str);
+        this.ws?.send(str);
     }
     subscribe(token, handler) {
         this.subscribers += 1;
@@ -1058,7 +1076,7 @@ const uploadFromUrl = (sourceUrl, { publicKey, fileName, baseURL, baseCDN, check
 }))
     .catch((error) => {
     const pusher = getPusher(pusherKey);
-    pusher === null || pusher === void 0 ? void 0 : pusher.disconnect();
+    pusher?.disconnect();
     return Promise.reject(error);
 })
     .then((urlResponse) => {
@@ -1218,7 +1236,7 @@ const uploadMultipart = (file, { publicKey, fileName, fileSize, baseURL, secureS
     return multipartStart(size, {
         publicKey,
         contentType,
-        fileName: fileName !== null && fileName !== void 0 ? fileName : file.name,
+        fileName: fileName ?? file.name,
         baseURL,
         secureSignature,
         secureExpire,
@@ -1470,7 +1488,10 @@ function uploadFileGroup(data, { publicKey, fileName, baseURL = defaultSettings.
 /**
  * Populate options with settings.
  */
-const populateOptionsWithSettings = (options, settings) => (Object.assign(Object.assign({}, settings), options));
+const populateOptionsWithSettings = (options, settings) => ({
+    ...settings,
+    ...options
+});
 class UploadClient {
     constructor(settings) {
         this.settings = Object.assign({}, defaultSettings, settings);