@uploadcare/upload-client 6.0.1-alpha.8 → 6.1.0-alpha.0

package/dist/index.react-native.js

@@ -157,6 +157,26 @@ const poll = ({ check, interval = DEFAULT_INTERVAL, timeout, signal }) => new Pr
     tickTimeoutId = setTimeout(tick, 0);
 });
 
+/*
+  Settings for future support:
+  parallelDirectUploads: 10,
+ */
+const defaultSettings = {
+    baseCDN: 'https://ucarecdn.com',
+    baseURL: 'https://upload.uploadcare.com',
+    maxContentLength: 50 * 1024 * 1024,
+    retryThrottledRequestMaxTimes: 1,
+    retryNetworkErrorMaxTimes: 3,
+    multipartMinFileSize: 25 * 1024 * 1024,
+    multipartChunkSize: 5 * 1024 * 1024,
+    multipartMinLastPartSize: 1024 * 1024,
+    maxConcurrentRequests: 4,
+    pollingTimeoutMilliseconds: 10000,
+    pusherKey: '79ae88bd931ea68464d9'
+};
+const defaultContentType = 'application/octet-stream';
+const defaultFilename = 'original';
+
 const request = ({ method, url, data, headers = {}, signal, onProgress }) => new Promise((resolve, reject) => {
     const xhr = new XMLHttpRequest();
     const requestMethod = method?.toUpperCase() || 'GET';
@@ -168,14 +188,12 @@ const request = ({ method, url, data, headers = {}, signal, onProgress }) => new
      * and https://bugs.chromium.org/p/chromium/issues/detail?id=1346628
      */
     xhr.open(requestMethod, url, true);
-    console.log(`xhr.open(${requestMethod}, ${url}, true)`);
     if (headers) {
         Object.entries(headers).forEach((entry) => {
             const [key, value] = entry;
             typeof value !== 'undefined' &&
                 !Array.isArray(value) &&
                 xhr.setRequestHeader(key, value);
-            console.log(`xhr.setRequestHeader(${key}, ${value})`);
         });
     }
     xhr.responseType = 'text';
@@ -227,7 +245,6 @@ const request = ({ method, url, data, headers = {}, signal, onProgress }) => new
     xhr.onerror = (progressEvent) => {
         if (aborted)
             return;
-        console.log('aboirt', xhr, progressEvent);
         // only triggers if the request couldn't be made at all
         reject(new UploadcareNetworkError(progressEvent));
     };
@@ -245,7 +262,6 @@ const request = ({ method, url, data, headers = {}, signal, onProgress }) => new
         };
     }
     if (data) {
-        console.log(`xhr.send(${data})`);
         xhr.send(data);
     }
     else {
@@ -253,26 +269,28 @@ const request = ({ method, url, data, headers = {}, signal, onProgress }) => new
     }
 });
 
-const isReactNativeUri = (uri) => {
-    if (typeof uri !== 'string') {
-        return false;
-    }
-    return uri.startsWith('file:') || uri.startsWith('content:');
+const isBlob = (data) => {
+    return typeof Blob !== 'undefined' && data instanceof Blob;
 };
-const isReactNativeAsset = (asset) => {
-    return (!!asset &&
-        typeof asset === 'object' &&
-        !Array.isArray(asset) &&
-        'uri' in asset &&
-        typeof asset.uri === 'string' &&
-        isReactNativeUri(asset.uri));
+const isFile = (data) => {
+    return typeof File !== 'undefined' && data instanceof File;
+};
+const isBuffer = (data) => {
+    return typeof Buffer !== 'undefined' && data instanceof Buffer;
+};
+const isReactNativeAsset = (data) => {
+    return (!!data &&
+        typeof data === 'object' &&
+        !Array.isArray(data) &&
+        'uri' in data &&
+        typeof data.uri === 'string');
+};
+const isFileData = (data) => {
+    return (isBlob(data) || isFile(data) || isBuffer(data) || isReactNativeAsset(data));
 };
 
-const getFileOptions = ({ name }) => name ? [name] : [];
+const getFileOptions = () => [];
 const transformFile = (file, name, contentType) => {
-    if (isReactNativeUri(file)) {
-        return { uri: file, name, type: contentType };
-    }
     if (isReactNativeAsset(file)) {
         return {
             uri: file.uri,
@@ -280,41 +298,14 @@ const transformFile = (file, name, contentType) => {
             type: file.type || contentType
         };
     }
-    const uri = URL.createObjectURL(file);
-    return { uri, name, type: contentType };
+    if (isBlob(file)) {
+        const uri = URL.createObjectURL(file);
+        return { uri, name: name, type: file.type || contentType };
+    }
+    throw new Error(`Unsupported file type.`);
 };
 var getFormData = () => new FormData();
 
-/**
- * FileData type guard.
- */
-const isFileData = (data) => {
-    return (data !== undefined &&
-        ((typeof Blob !== 'undefined' && data instanceof Blob) ||
-            (typeof File !== 'undefined' && data instanceof File) ||
-            (typeof Buffer !== 'undefined' && data instanceof Buffer) ||
-            (typeof data === 'string' && isReactNativeUri(data)) ||
-            (typeof data === 'object' && isReactNativeAsset(data))));
-};
-/**
- * Uuid type guard.
- */
-const isUuid = (data) => {
-    const UUID_REGEX = '[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}';
-    const regExp = new RegExp(UUID_REGEX);
-    return !isFileData(data) && regExp.test(data);
-};
-/**
- * Url type guard.
- *
- * @param {NodeFile | BrowserFile | Url | Uuid} data
- */
-const isUrl = (data) => {
-    const URL_REGEX = '^(?:\\w+:)?\\/\\/([^\\s\\.]+\\.\\S{2}|localhost[\\:?\\d]*)\\S*$';
-    const regExp = new RegExp(URL_REGEX);
-    return !isFileData(data) && regExp.test(data);
-};
-
 const isSimpleValue = (value) => {
     return (typeof value === 'string' ||
         typeof value === 'number' ||
@@ -330,8 +321,8 @@ const isFileValue = (value) => !!value &&
 function collectParams(params, inputKey, inputValue) {
     if (isFileValue(inputValue)) {
         const { name, contentType } = inputValue;
-        const file = transformFile(inputValue.data, name, contentType); // lgtm [js/superfluous-trailing-arguments]
-        const options = getFileOptions({ name, contentType });
+        const file = transformFile(inputValue.data, name, contentType);
+        const options = getFileOptions();
         params.push([inputKey, file, ...options]);
     }
     else if (isObjectValue(inputValue)) {
@@ -353,11 +344,9 @@ function getFormDataParams(options) {
     return params;
 }
 function buildFormData(options) {
-    console.log('buildFormData', options);
     const formData = getFormData();
     const paramsList = getFormDataParams(options);
     for (const params of paramsList) {
-        console.log('params', params);
         const [key, value, ...rest] = params;
         // node form-data has another signature for append
         formData.append(key, value, ...rest);
@@ -365,6 +354,19 @@ function buildFormData(options) {
     return formData;
 }
 
+class UploadClientError extends Error {
+    constructor(message, code, request, response, headers) {
+        super();
+        this.name = 'UploadClientError';
+        this.message = message;
+        this.code = code;
+        this.request = request;
+        this.response = response;
+        this.headers = headers;
+        Object.setPrototypeOf(this, UploadClientError.prototype);
+    }
+}
+
 const buildSearchParams = (query) => {
     const searchParams = new URLSearchParams();
     for (const [key, value] of Object.entries(query)) {
@@ -396,26 +398,6 @@ const getUrl = (base, path, query) => {
     return url.toString();
 };
 
-/*
-  Settings for future support:
-  parallelDirectUploads: 10,
- */
-const defaultSettings = {
-    baseCDN: 'https://ucarecdn.com',
-    baseURL: 'https://upload.uploadcare.com',
-    maxContentLength: 50 * 1024 * 1024,
-    retryThrottledRequestMaxTimes: 1,
-    retryNetworkErrorMaxTimes: 3,
-    multipartMinFileSize: 25 * 1024 * 1024,
-    multipartChunkSize: 5 * 1024 * 1024,
-    multipartMinLastPartSize: 1024 * 1024,
-    maxConcurrentRequests: 4,
-    pollingTimeoutMilliseconds: 10000,
-    pusherKey: '79ae88bd931ea68464d9'
-};
-const defaultContentType = 'application/octet-stream';
-const defaultFilename = 'original';
-
 var version = '6.0.0';
 
 const LIBRARY_NAME = 'UploadcareUploadClient';
@@ -428,19 +410,6 @@ function getUserAgent(options) {
     });
 }
 
-class UploadClientError extends Error {
-    constructor(message, code, request, response, headers) {
-        super();
-        this.name = 'UploadClientError';
-        this.message = message;
-        this.code = code;
-        this.request = request;
-        this.response = response;
-        this.headers = headers;
-        Object.setPrototypeOf(this, UploadClientError.prototype);
-    }
-}
-
 const REQUEST_WAS_THROTTLED_CODE = 'RequestThrottledError';
 const DEFAULT_RETRY_AFTER_TIMEOUT = 15000;
 const DEFAULT_NETWORK_ERROR_TIMEOUT = 1000;
@@ -471,6 +440,36 @@ function retryIfFailed(fn, options) {
     }));
 }
 
+const getContentType = (file) => {
+    let contentType = '';
+    if (isBlob(file) || isFile(file) || isReactNativeAsset(file)) {
+        contentType = file.type;
+    }
+    if (contentType) {
+        return contentType;
+    }
+    console.warn(`Cannot determine content type. Using default content type: ${defaultContentType}`, file);
+    return defaultContentType;
+};
+
+const getFileName = (file) => {
+    let filename = '';
+    if (isFile(file) && file.name) {
+        filename = file.name;
+    }
+    else if (isBlob(file) || isBuffer(file)) {
+        filename = '';
+    }
+    else if (isReactNativeAsset(file) && file.name) {
+        filename = file.name;
+    }
+    if (filename) {
+        return filename;
+    }
+    console.warn(`Cannot determine filename. Using default filename: ${defaultFilename}`, file);
+    return defaultFilename;
+};
+
 function getStoreValue(store) {
     return typeof store === 'undefined' ? 'auto' : store ? '1' : '0';
 }
@@ -486,13 +485,13 @@ function base(file, { publicKey, fileName, contentType, baseURL = defaultSetting
             jsonerrors: 1
         }),
         headers: {
-            'X-UC-User-Agent': getUserAgent({ publicKey, integration, userAgent }),
+            'X-UC-User-Agent': getUserAgent({ publicKey, integration, userAgent })
         },
         data: buildFormData({
             file: {
                 data: file,
-                name: fileName ?? file?.name ?? defaultFilename,
-                contentType: contentType ?? file?.type ?? defaultContentType
+                name: fileName || getFileName(file),
+                contentType: contentType || getContentType(file)
             },
             UPLOADCARE_PUB_KEY: publicKey,
             UPLOADCARE_STORE: getStoreValue(store),
@@ -690,9 +689,9 @@ function multipartStart(size, { publicKey, contentType, fileName, multipartChunk
             'X-UC-User-Agent': getUserAgent({ publicKey, integration, userAgent })
         },
         data: buildFormData({
-            filename: fileName ?? defaultFilename,
+            filename: fileName || defaultFilename,
             size: size,
-            content_type: contentType ?? defaultContentType,
+            content_type: contentType || defaultContentType,
             part_size: multipartChunkSize,
             UPLOADCARE_STORE: getStoreValue(store),
             UPLOADCARE_PUB_KEY: publicKey,
@@ -769,6 +768,28 @@ function multipartComplete(uuid, { publicKey, baseURL = defaultSettings.baseURL,
     }), { retryThrottledRequestMaxTimes, retryNetworkErrorMaxTimes });
 }
 
+function isReadyPoll({ file, publicKey, baseURL, source, integration, userAgent, retryThrottledRequestMaxTimes, retryNetworkErrorMaxTimes, signal, onProgress }) {
+    return poll({
+        check: (signal) => info(file, {
+            publicKey,
+            baseURL,
+            signal,
+            source,
+            integration,
+            userAgent,
+            retryThrottledRequestMaxTimes,
+            retryNetworkErrorMaxTimes
+        }).then((response) => {
+            if (response.isReady) {
+                return response;
+            }
+            onProgress && onProgress({ isComputable: true, value: 1 });
+            return false;
+        }),
+        signal
+    });
+}
+
 class UploadcareFile {
     constructor(fileInfo, { baseCDN, fileName }) {
         this.name = null;
@@ -806,28 +827,6 @@ class UploadcareFile {
     }
 }
 
-function isReadyPoll({ file, publicKey, baseURL, source, integration, userAgent, retryThrottledRequestMaxTimes, retryNetworkErrorMaxTimes, signal, onProgress }) {
-    return poll({
-        check: (signal) => info(file, {
-            publicKey,
-            baseURL,
-            signal,
-            source,
-            integration,
-            userAgent,
-            retryThrottledRequestMaxTimes,
-            retryNetworkErrorMaxTimes
-        }).then((response) => {
-            if (response.isReady) {
-                return response;
-            }
-            onProgress && onProgress({ isComputable: true, value: 1 });
-            return false;
-        }),
-        signal
-    });
-}
-
 const uploadDirect = (file, { publicKey, fileName, baseURL, secureSignature, secureExpire, store, contentType, signal, onProgress, source, integration, userAgent, retryThrottledRequestMaxTimes, retryNetworkErrorMaxTimes, baseCDN, metadata }) => {
     return base(file, {
         publicKey,
@@ -863,6 +862,29 @@ const uploadDirect = (file, { publicKey, fileName, baseURL, secureSignature, sec
         .then((fileInfo) => new UploadcareFile(fileInfo, { baseCDN }));
 };
 
+const uploadFromUploaded = (uuid, { publicKey, fileName, baseURL, signal, onProgress, source, integration, userAgent, retryThrottledRequestMaxTimes, retryNetworkErrorMaxTimes, baseCDN }) => {
+    return info(uuid, {
+        publicKey,
+        baseURL,
+        signal,
+        source,
+        integration,
+        userAgent,
+        retryThrottledRequestMaxTimes,
+        retryNetworkErrorMaxTimes
+    })
+        .then((fileInfo) => new UploadcareFile(fileInfo, { baseCDN, fileName }))
+        .then((result) => {
+        // hack for node ¯\_(ツ)_/¯
+        if (onProgress)
+            onProgress({
+                isComputable: true,
+                value: 1
+            });
+        return result;
+    });
+};
+
 const race = (fns, { signal } = {}) => {
     let lastError = null;
     let winnerIndex = null;
@@ -1202,35 +1224,30 @@ const uploadFromUrl = (sourceUrl, { publicKey, fileName, baseURL, baseCDN, check
 }))
     .then((fileInfo) => new UploadcareFile(fileInfo, { baseCDN }));
 
-const uploadFromUploaded = (uuid, { publicKey, fileName, baseURL, signal, onProgress, source, integration, userAgent, retryThrottledRequestMaxTimes, retryNetworkErrorMaxTimes, baseCDN }) => {
-    return info(uuid, {
-        publicKey,
-        baseURL,
-        signal,
-        source,
-        integration,
-        userAgent,
-        retryThrottledRequestMaxTimes,
-        retryNetworkErrorMaxTimes
-    })
-        .then((fileInfo) => new UploadcareFile(fileInfo, { baseCDN, fileName }))
-        .then((result) => {
-        // hack for node ¯\_(ツ)_/¯
-        if (onProgress)
-            onProgress({
-                isComputable: true,
-                value: 1
-            });
-        return result;
-    });
+const memo = new WeakMap();
+const getBlobFromReactNativeAsset = async (asset) => {
+    if (memo.has(asset)) {
+        return memo.get(asset);
+    }
+    const blob = await fetch(asset.uri).then((res) => res.blob());
+    memo.set(asset, blob);
+    return blob;
 };
 
-/**
- * Get file size.
- */
-const getFileSize = (file) => {
-    return file.length || file.size;
+const getFileSize = async (file) => {
+    if (isBuffer(file)) {
+        return file.length;
+    }
+    if (isFile(file) || isBlob(file)) {
+        return file.size;
+    }
+    if (isReactNativeAsset(file)) {
+        const blob = await getBlobFromReactNativeAsset(file);
+        return blob.size;
+    }
+    throw new Error(`Unknown file type. Cannot determine file size.`);
 };
+
 /**
  * Check if FileData is multipart data.
  */
@@ -1238,28 +1255,24 @@ const isMultipart = (fileSize, multipartMinFileSize = defaultSettings.multipartM
     return fileSize >= multipartMinFileSize;
 };
 
-const sliceChunk = (file, index, fileSize, chunkSize) => {
-    const start = chunkSize * index;
-    const end = Math.min(start + chunkSize, fileSize);
-    return file.slice(start, end);
+/**
+ * Uuid type guard.
+ */
+const isUuid = (data) => {
+    const UUID_REGEX = '[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}';
+    const regExp = new RegExp(UUID_REGEX);
+    return !isFileData(data) && regExp.test(data);
 };
-
 /**
- * React-native hack for blob slicing
- *
- * We need to store references to sliced blobs to prevent source blob from
- * being deallocated until uploading complete. Access to deallocated blob
- * causes app crash.
+ * Url type guard.
  *
- * See https://github.com/uploadcare/uploadcare-js-api-clients/issues/306
- * and https://github.com/facebook/react-native/issues/27543
+ * @param {SupportedFileInput | Url | Uuid} data
  */
-function prepareChunks(file, fileSize, chunkSize) {
-    return (index) => {
-        const chunk = sliceChunk(file, index, fileSize, chunkSize);
-        return chunk;
-    };
-}
+const isUrl = (data) => {
+    const URL_REGEX = '^(?:\\w+:)?\\/\\/([^\\s\\.]+\\.\\S{2}|localhost[\\:?\\d]*)\\S*$';
+    const regExp = new RegExp(URL_REGEX);
+    return !isFileData(data) && regExp.test(data);
+};
 
 const runWithConcurrency = (concurrency, tasks) => {
     return new Promise((resolve, reject) => {
@@ -1296,6 +1309,36 @@ const runWithConcurrency = (concurrency, tasks) => {
     });
 };
 
+const sliceChunk = (file, index, fileSize, chunkSize) => {
+    const start = chunkSize * index;
+    const end = Math.min(start + chunkSize, fileSize);
+    return file.slice(start, end);
+};
+
+/**
+ * React-native hack for blob slicing
+ *
+ * We need to store references to sliced blobs to prevent source blob from
+ * being deallocated until uploading complete. Access to deallocated blob
+ * causes app crash.
+ *
+ * See https://github.com/uploadcare/uploadcare-js-api-clients/issues/306
+ * and https://github.com/facebook/react-native/issues/27543
+ */
+const prepareChunks = async (file, fileSize, chunkSize) => {
+    let blob;
+    if (isReactNativeAsset(file)) {
+        blob = await getBlobFromReactNativeAsset(file);
+    }
+    else {
+        blob = file;
+    }
+    return (index) => {
+        const chunk = sliceChunk(blob, index, fileSize, chunkSize);
+        return chunk;
+    };
+};
+
 const uploadPart = (chunk, url, { publicKey, onProgress, signal, integration, retryThrottledRequestMaxTimes, retryNetworkErrorMaxTimes }) => multipartUpload(chunk, url, {
     publicKey,
     onProgress,
@@ -1304,8 +1347,8 @@ const uploadPart = (chunk, url, { publicKey, onProgress, signal, integration, re
     retryThrottledRequestMaxTimes,
     retryNetworkErrorMaxTimes
 });
-const uploadMultipart = (file, { publicKey, fileName, fileSize, baseURL, secureSignature, secureExpire, store, signal, onProgress, source, integration, userAgent, retryThrottledRequestMaxTimes, retryNetworkErrorMaxTimes, contentType, multipartChunkSize = defaultSettings.multipartChunkSize, maxConcurrentRequests = defaultSettings.maxConcurrentRequests, baseCDN, metadata }) => {
-    const size = fileSize || getFileSize(file);
+const uploadMultipart = async (file, { publicKey, fileName, fileSize, baseURL, secureSignature, secureExpire, store, signal, onProgress, source, integration, userAgent, retryThrottledRequestMaxTimes, retryNetworkErrorMaxTimes, contentType, multipartChunkSize = defaultSettings.multipartChunkSize, maxConcurrentRequests = defaultSettings.maxConcurrentRequests, baseCDN, metadata }) => {
+    const size = fileSize ?? (await getFileSize(file));
     let progressValues;
     const createProgressHandler = (totalChunks, chunkIdx) => {
         if (!onProgress)
@@ -1327,8 +1370,8 @@ const uploadMultipart = (file, { publicKey, fileName, fileSize, baseURL, secureS
     };
     return multipartStart(size, {
         publicKey,
-        contentType,
-        fileName: fileName ?? file.name,
+        contentType: contentType || getContentType(file),
+        fileName: fileName || getFileName(file),
         baseURL,
         secureSignature,
         secureExpire,
@@ -1341,8 +1384,8 @@ const uploadMultipart = (file, { publicKey, fileName, fileSize, baseURL, secureS
         retryNetworkErrorMaxTimes,
         metadata
     })
-        .then(({ uuid, parts }) => {
-        const getChunk = prepareChunks(file, size, multipartChunkSize);
+        .then(async ({ uuid, parts }) => {
+        const getChunk = await prepareChunks(file, size, multipartChunkSize);
         return Promise.all([
             uuid,
             runWithConcurrency(maxConcurrentRequests, parts.map((url, index) => () => uploadPart(getChunk(index), url, {
@@ -1389,14 +1432,15 @@ const uploadMultipart = (file, { publicKey, fileName, fileSize, baseURL, secureS
 /**
  * Uploads file from provided data.
  */
-function uploadFile(data, { publicKey, fileName, baseURL = defaultSettings.baseURL, secureSignature, secureExpire, store, signal, onProgress, source, integration, userAgent, retryThrottledRequestMaxTimes, retryNetworkErrorMaxTimes, contentType, multipartMinFileSize, multipartChunkSize, maxConcurrentRequests, baseCDN = defaultSettings.baseCDN, checkForUrlDuplicates, saveUrlForRecurrentUploads, pusherKey, metadata }) {
+async function uploadFile(data, { publicKey, fileName, baseURL = defaultSettings.baseURL, secureSignature, secureExpire, store, signal, onProgress, source, integration, userAgent, retryThrottledRequestMaxTimes, retryNetworkErrorMaxTimes, contentType, multipartMinFileSize, multipartChunkSize, maxConcurrentRequests, baseCDN = defaultSettings.baseCDN, checkForUrlDuplicates, saveUrlForRecurrentUploads, pusherKey, metadata }) {
     if (isFileData(data)) {
-        const fileSize = getFileSize(data);
+        const fileSize = await getFileSize(data);
         if (isMultipart(fileSize, multipartMinFileSize)) {
             return uploadMultipart(data, {
                 publicKey,
                 contentType,
                 multipartChunkSize,
+                fileSize,
                 fileName,
                 baseURL,
                 secureSignature,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uploadcare/upload-client",
-  "version": "6.0.1-alpha.8",
+  "version": "6.1.0-alpha.0",
   "description": "Library for work with Uploadcare Upload API",
   "type": "module",
   "module": "./dist/index.node.js",
@@ -71,8 +71,8 @@
     "@types/ws": "8.5.3",
     "data-uri-to-buffer": "3.0.1",
     "dataurl-to-blob": "0.0.1",
-    "jest-environment-jsdom": "28.1.0",
-    "jest-websocket-mock": "2.3.0",
+    "jest-environment-jsdom": "29.3.1",
+    "jest-websocket-mock": "2.4.0",
     "koa": "2.13.4",
     "koa-add-trailing-slashes": "2.0.1",
     "koa-body": "5.0.0",