@uploadcare/upload-client 6.5.0 → 6.6.0

package/README.md

@@ -23,6 +23,7 @@ Node.js and browser.
   - [High-Level API](#high-level-api)
   - [Low-Level API](#low-level-api)
   - [Settings](#settings)
+  - [Uploading queue](#uploading-queue)
 - [React Native](#react-native)
 - [Testing](#testing)
 - [Security issues](#security-issues)
@@ -54,9 +55,7 @@ Once the UploadClient instance is created, you can start using the wrapper to
 upload files from binary data:
 
 ```javascript
-client
-  .uploadFile(fileData)
-  .then(file => console.log(file.uuid))
+client.uploadFile(fileData).then((file) => console.log(file.uuid))
 ```
 
 Another option is uploading files from URL, via the `uploadFile` method:
@@ -64,9 +63,7 @@ Another option is uploading files from URL, via the `uploadFile` method:
 ```javascript
 const fileURL = 'https://example.com/file.jpg'
 
-client
-  .uploadFile(fileURL)
-  .then(file => console.log(file.uuid))
+client.uploadFile(fileURL).then((file) => console.log(file.uuid))
 ```
 
 You can also use the `uploadFile` method to get previously uploaded files via
@@ -75,9 +72,7 @@ their UUIDs:
 ```javascript
 const fileUUID = 'edfdf045-34c0-4087-bbdd-e3834921f890'
 
-client
-  .uploadFile(fileUUID)
-  .then(file => console.log(file.uuid))
+client.uploadFile(fileUUID).then((file) => console.log(file.uuid))
 ```
 
 You can track uploading progress:
@@ -90,7 +85,7 @@ const onProgress = ({ isComputable, value }) => {
 
 client
   .uploadFile(fileUUID, { onProgress })
-  .then(file => console.log(file.uuid))
+  .then((file) => console.log(file.uuid))
 ```
 
 Note that `isComputable` flag can be `false` is some cases of uploading from the URL.
@@ -105,8 +100,8 @@ const abortController = new AbortController()
 
 client
   .uploadFile(fileUUID, { signal: abortController.signal })
-  .then(file => console.log(file.uuid))
-  .catch(error => {
+  .then((file) => console.log(file.uuid))
+  .catch((error) => {
     if (error.isCancel) {
       console.log(`File uploading was canceled.`)
     }
@@ -194,8 +189,8 @@ const onProgress = ({ isComputable, value }) => console.log(isComputable, value)
 const abortController = new AbortController()
 
 base(fileData, { onProgress, signal: abortController.signal }) // fileData must be `Blob` or `File` or `Buffer`
-  .then(data => console.log(data.file))
-  .catch(error => {
+  .then((data) => console.log(data.file))
+  .catch((error) => {
     if (error.isCancel) {
       console.log(`File uploading was canceled.`)
     }
@@ -421,6 +416,55 @@ Non-string values will be converted to `string`. `undefined` values will be igno
 
 See [docs][uc-file-metadata] and [REST API][uc-docs-metadata] for details.
 
+### Uploading queue
+
+If you're going to upload a lot of files at once, it's useful to do it in a queue. Otherwise, a large number of simultaneous requests can clog the internet channel and slow down the process.
+
+To solve this problem, we provide a simple helper called `Queue`.
+
+Here is an example of how to use it:
+
+```typescript
+import { Queue, uploadFile } from '@uploadcare/upload-client'
+
+// Create a queue with a limit of 10 concurrent requests.
+const queue = new Queue(10)
+
+// Create an array containing 50 files.
+const files = [
+  ...Array(50)
+    .fill(0)
+    .map((_, idx) => Buffer.from(`content-${idx}`))
+]
+const promises = files.map((file, idx) => {
+  const fileName = `file-${idx}.txt`
+  return queue
+    .add(() =>
+      uploadFile(file, {
+        publicKey: 'YOUR_PUBLIC_KEY',
+        contentType: 'plain/text',
+        fileName
+      })
+    )
+    .then((fileInfo) =>
+      console.log(
+        `"File "${fileName}" has been successfully uploaded! You can access it at the following URL: "${fileInfo.cdnUrl}"`
+      )
+    )
+})
+
+await Promise.all(promises)
+
+console.log('Files have been successfully uploaded')
+```
+
+You can pass any function that returns a promise to `queue.add`, and it will be executed concurrently.
+
+`queue.add` returns a promise that mimics the one passed in, meaning it will resolve or reject with the corresponding values.
+
+If the functionality of the built-in `Queue` is not sufficient for you, you can use any other third-party, more functional solution.
+
+
 ## React Native
 
 ### Prepare

package/dist/cjs/index.browser.cjs

@@ -398,7 +398,7 @@ const getUrl = (base, path, query) => {
     return url.toString();
 };
 
-var version = '6.5.0';
+var version = '6.6.0';
 
 const LIBRARY_NAME = 'UploadcareUploadClient';
 const LIBRARY_VERSION = version;
@@ -1656,6 +1656,62 @@ class UploadClient {
     }
 }
 
+class Queue {
+    #concurrency = 1;
+    #pending = [];
+    #running = 0;
+    #resolvers = new WeakMap();
+    #rejectors = new WeakMap();
+    constructor(concurrency) {
+        this.#concurrency = concurrency;
+    }
+    #run() {
+        const tasksLeft = this.#concurrency - this.#running;
+        for (let i = 0; i < tasksLeft; i++) {
+            const task = this.#pending.shift();
+            if (!task) {
+                return;
+            }
+            const resolver = this.#resolvers.get(task);
+            const rejector = this.#rejectors.get(task);
+            if (!resolver || !rejector)
+                throw new Error('Unexpected behavior: resolver or rejector is undefined');
+            this.#running += 1;
+            task()
+                .finally(() => {
+                this.#resolvers.delete(task);
+                this.#rejectors.delete(task);
+                this.#running -= 1;
+                this.#run();
+            })
+                .then((value) => resolver(value))
+                .catch((error) => rejector(error));
+        }
+    }
+    add(task) {
+        return new Promise((resolve, reject) => {
+            this.#resolvers.set(task, resolve);
+            this.#rejectors.set(task, reject);
+            this.#pending.push(task);
+            this.#run();
+        });
+    }
+    get pending() {
+        return this.#pending.length;
+    }
+    get running() {
+        return this.#running;
+    }
+    set concurrency(value) {
+        this.#concurrency = value;
+        this.#run();
+    }
+    get concurrency() {
+        return this.#concurrency;
+    }
+}
+
+exports.Queue = Queue;
 exports.UploadClient = UploadClient;
 exports.UploadClientError = UploadClientError;
 exports.UploadcareFile = UploadcareFile;

package/dist/cjs/index.browser.d.cts

@@ -472,6 +472,16 @@ export declare class UploadClient {
 	uploadFile(data: SupportedFileInput | Url | Uuid, options?: Partial<FileFromOptions>): Promise<UploadcareFile>;
 	uploadFileGroup(data: SupportedFileInput[] | Url[] | Uuid[], options?: Partial<FileFromOptions & GroupFromOptions>): Promise<UploadcareGroup>;
 }
+export type Task<T = unknown> = () => Promise<T>;
+export declare class Queue {
+	#private;
+	constructor(concurrency: number);
+	add<T>(task: Task<T>): Promise<T>;
+	get pending(): number;
+	get running(): number;
+	set concurrency(value: number);
+	get concurrency(): number;
+}
 export type Headers = {
 	[key: string]: string | string[] | undefined;
 };

package/dist/cjs/index.node.cjs

@@ -429,7 +429,7 @@ const getUrl = (base, path, query) => {
     return url.toString();
 };
 
-var version = '6.5.0';
+var version = '6.6.0';
 
 const LIBRARY_NAME = 'UploadcareUploadClient';
 const LIBRARY_VERSION = version;
@@ -1685,6 +1685,62 @@ class UploadClient {
     }
 }
 
+class Queue {
+    #concurrency = 1;
+    #pending = [];
+    #running = 0;
+    #resolvers = new WeakMap();
+    #rejectors = new WeakMap();
+    constructor(concurrency) {
+        this.#concurrency = concurrency;
+    }
+    #run() {
+        const tasksLeft = this.#concurrency - this.#running;
+        for (let i = 0; i < tasksLeft; i++) {
+            const task = this.#pending.shift();
+            if (!task) {
+                return;
+            }
+            const resolver = this.#resolvers.get(task);
+            const rejector = this.#rejectors.get(task);
+            if (!resolver || !rejector)
+                throw new Error('Unexpected behavior: resolver or rejector is undefined');
+            this.#running += 1;
+            task()
+                .finally(() => {
+                this.#resolvers.delete(task);
+                this.#rejectors.delete(task);
+                this.#running -= 1;
+                this.#run();
+            })
+                .then((value) => resolver(value))
+                .catch((error) => rejector(error));
+        }
+    }
+    add(task) {
+        return new Promise((resolve, reject) => {
+            this.#resolvers.set(task, resolve);
+            this.#rejectors.set(task, reject);
+            this.#pending.push(task);
+            this.#run();
+        });
+    }
+    get pending() {
+        return this.#pending.length;
+    }
+    get running() {
+        return this.#running;
+    }
+    set concurrency(value) {
+        this.#concurrency = value;
+        this.#run();
+    }
+    get concurrency() {
+        return this.#concurrency;
+    }
+}
+
+exports.Queue = Queue;
 exports.UploadClient = UploadClient;
 exports.UploadClientError = UploadClientError;
 exports.UploadcareFile = UploadcareFile;

package/dist/cjs/index.node.d.cts

@@ -472,6 +472,16 @@ export declare class UploadClient {
 	uploadFile(data: SupportedFileInput | Url | Uuid, options?: Partial<FileFromOptions>): Promise<UploadcareFile>;
 	uploadFileGroup(data: SupportedFileInput[] | Url[] | Uuid[], options?: Partial<FileFromOptions & GroupFromOptions>): Promise<UploadcareGroup>;
 }
+export type Task<T = unknown> = () => Promise<T>;
+export declare class Queue {
+	#private;
+	constructor(concurrency: number);
+	add<T>(task: Task<T>): Promise<T>;
+	get pending(): number;
+	get running(): number;
+	set concurrency(value: number);
+	get concurrency(): number;
+}
 export type Headers = {
 	[key: string]: string | string[] | undefined;
 };

package/dist/cjs/index.react-native.cjs

@@ -406,7 +406,7 @@ const getUrl = (base, path, query) => {
     return url.toString();
 };
 
-var version = '6.5.0';
+var version = '6.6.0';
 
 const LIBRARY_NAME = 'UploadcareUploadClient';
 const LIBRARY_VERSION = version;
@@ -1684,6 +1684,62 @@ class UploadClient {
     }
 }
 
+class Queue {
+    #concurrency = 1;
+    #pending = [];
+    #running = 0;
+    #resolvers = new WeakMap();
+    #rejectors = new WeakMap();
+    constructor(concurrency) {
+        this.#concurrency = concurrency;
+    }
+    #run() {
+        const tasksLeft = this.#concurrency - this.#running;
+        for (let i = 0; i < tasksLeft; i++) {
+            const task = this.#pending.shift();
+            if (!task) {
+                return;
+            }
+            const resolver = this.#resolvers.get(task);
+            const rejector = this.#rejectors.get(task);
+            if (!resolver || !rejector)
+                throw new Error('Unexpected behavior: resolver or rejector is undefined');
+            this.#running += 1;
+            task()
+                .finally(() => {
+                this.#resolvers.delete(task);
+                this.#rejectors.delete(task);
+                this.#running -= 1;
+                this.#run();
+            })
+                .then((value) => resolver(value))
+                .catch((error) => rejector(error));
+        }
+    }
+    add(task) {
+        return new Promise((resolve, reject) => {
+            this.#resolvers.set(task, resolve);
+            this.#rejectors.set(task, reject);
+            this.#pending.push(task);
+            this.#run();
+        });
+    }
+    get pending() {
+        return this.#pending.length;
+    }
+    get running() {
+        return this.#running;
+    }
+    set concurrency(value) {
+        this.#concurrency = value;
+        this.#run();
+    }
+    get concurrency() {
+        return this.#concurrency;
+    }
+}
+
+exports.Queue = Queue;
 exports.UploadClient = UploadClient;
 exports.UploadClientError = UploadClientError;
 exports.UploadcareFile = UploadcareFile;

package/dist/cjs/index.react-native.d.cts

@@ -472,6 +472,16 @@ export declare class UploadClient {
 	uploadFile(data: SupportedFileInput | Url | Uuid, options?: Partial<FileFromOptions>): Promise<UploadcareFile>;
 	uploadFileGroup(data: SupportedFileInput[] | Url[] | Uuid[], options?: Partial<FileFromOptions & GroupFromOptions>): Promise<UploadcareGroup>;
 }
+export type Task<T = unknown> = () => Promise<T>;
+export declare class Queue {
+	#private;
+	constructor(concurrency: number);
+	add<T>(task: Task<T>): Promise<T>;
+	get pending(): number;
+	get running(): number;
+	set concurrency(value: number);
+	get concurrency(): number;
+}
 export type Headers = {
 	[key: string]: string | string[] | undefined;
 };

package/dist/esm/index.browser.d.mts

@@ -472,6 +472,16 @@ export declare class UploadClient {
 	uploadFile(data: SupportedFileInput | Url | Uuid, options?: Partial<FileFromOptions>): Promise<UploadcareFile>;
 	uploadFileGroup(data: SupportedFileInput[] | Url[] | Uuid[], options?: Partial<FileFromOptions & GroupFromOptions>): Promise<UploadcareGroup>;
 }
+export type Task<T = unknown> = () => Promise<T>;
+export declare class Queue {
+	#private;
+	constructor(concurrency: number);
+	add<T>(task: Task<T>): Promise<T>;
+	get pending(): number;
+	get running(): number;
+	set concurrency(value: number);
+	get concurrency(): number;
+}
 export type Headers = {
 	[key: string]: string | string[] | undefined;
 };

package/dist/esm/index.browser.mjs

@@ -396,7 +396,7 @@ const getUrl = (base, path, query) => {
     return url.toString();
 };
 
-var version = '6.5.0';
+var version = '6.6.0';
 
 const LIBRARY_NAME = 'UploadcareUploadClient';
 const LIBRARY_VERSION = version;
@@ -1654,4 +1654,59 @@ class UploadClient {
     }
 }
 
-export { UploadClient, UploadClientError, UploadcareFile, UploadcareGroup, UploadcareNetworkError, base, fromUrl, fromUrlStatus, getUserAgent$1 as getUserAgent, group, groupInfo, info, multipartComplete, multipartStart, multipartUpload, uploadDirect, uploadFile, uploadFileGroup, uploadFromUploaded, uploadFromUrl, uploadMultipart };
+class Queue {
+    #concurrency = 1;
+    #pending = [];
+    #running = 0;
+    #resolvers = new WeakMap();
+    #rejectors = new WeakMap();
+    constructor(concurrency) {
+        this.#concurrency = concurrency;
+    }
+    #run() {
+        const tasksLeft = this.#concurrency - this.#running;
+        for (let i = 0; i < tasksLeft; i++) {
+            const task = this.#pending.shift();
+            if (!task) {
+                return;
+            }
+            const resolver = this.#resolvers.get(task);
+            const rejector = this.#rejectors.get(task);
+            if (!resolver || !rejector)
+                throw new Error('Unexpected behavior: resolver or rejector is undefined');
+            this.#running += 1;
+            task()
+                .finally(() => {
+                this.#resolvers.delete(task);
+                this.#rejectors.delete(task);
+                this.#running -= 1;
+                this.#run();
+            })
+                .then((value) => resolver(value))
+                .catch((error) => rejector(error));
+        }
+    }
+    add(task) {
+        return new Promise((resolve, reject) => {
+            this.#resolvers.set(task, resolve);
+            this.#rejectors.set(task, reject);
+            this.#pending.push(task);
+            this.#run();
+        });
+    }
+    get pending() {
+        return this.#pending.length;
+    }
+    get running() {
+        return this.#running;
+    }
+    set concurrency(value) {
+        this.#concurrency = value;
+        this.#run();
+    }
+    get concurrency() {
+        return this.#concurrency;
+    }
+}
+
+export { Queue, UploadClient, UploadClientError, UploadcareFile, UploadcareGroup, UploadcareNetworkError, base, fromUrl, fromUrlStatus, getUserAgent$1 as getUserAgent, group, groupInfo, info, multipartComplete, multipartStart, multipartUpload, uploadDirect, uploadFile, uploadFileGroup, uploadFromUploaded, uploadFromUrl, uploadMultipart };

package/dist/esm/index.node.d.mts

@@ -472,6 +472,16 @@ export declare class UploadClient {
 	uploadFile(data: SupportedFileInput | Url | Uuid, options?: Partial<FileFromOptions>): Promise<UploadcareFile>;
 	uploadFileGroup(data: SupportedFileInput[] | Url[] | Uuid[], options?: Partial<FileFromOptions & GroupFromOptions>): Promise<UploadcareGroup>;
 }
+export type Task<T = unknown> = () => Promise<T>;
+export declare class Queue {
+	#private;
+	constructor(concurrency: number);
+	add<T>(task: Task<T>): Promise<T>;
+	get pending(): number;
+	get running(): number;
+	set concurrency(value: number);
+	get concurrency(): number;
+}
 export type Headers = {
 	[key: string]: string | string[] | undefined;
 };

package/dist/esm/index.node.mjs

@@ -427,7 +427,7 @@ const getUrl = (base, path, query) => {
     return url.toString();
 };
 
-var version = '6.5.0';
+var version = '6.6.0';
 
 const LIBRARY_NAME = 'UploadcareUploadClient';
 const LIBRARY_VERSION = version;
@@ -1683,4 +1683,59 @@ class UploadClient {
     }
 }
 
-export { UploadClient, UploadClientError, UploadcareFile, UploadcareGroup, UploadcareNetworkError, base, fromUrl, fromUrlStatus, getUserAgent$1 as getUserAgent, group, groupInfo, info, multipartComplete, multipartStart, multipartUpload, uploadDirect, uploadFile, uploadFileGroup, uploadFromUploaded, uploadFromUrl, uploadMultipart };
+class Queue {
+    #concurrency = 1;
+    #pending = [];
+    #running = 0;
+    #resolvers = new WeakMap();
+    #rejectors = new WeakMap();
+    constructor(concurrency) {
+        this.#concurrency = concurrency;
+    }
+    #run() {
+        const tasksLeft = this.#concurrency - this.#running;
+        for (let i = 0; i < tasksLeft; i++) {
+            const task = this.#pending.shift();
+            if (!task) {
+                return;
+            }
+            const resolver = this.#resolvers.get(task);
+            const rejector = this.#rejectors.get(task);
+            if (!resolver || !rejector)
+                throw new Error('Unexpected behavior: resolver or rejector is undefined');
+            this.#running += 1;
+            task()
+                .finally(() => {
+                this.#resolvers.delete(task);
+                this.#rejectors.delete(task);
+                this.#running -= 1;
+                this.#run();
+            })
+                .then((value) => resolver(value))
+                .catch((error) => rejector(error));
+        }
+    }
+    add(task) {
+        return new Promise((resolve, reject) => {
+            this.#resolvers.set(task, resolve);
+            this.#rejectors.set(task, reject);
+            this.#pending.push(task);
+            this.#run();
+        });
+    }
+    get pending() {
+        return this.#pending.length;
+    }
+    get running() {
+        return this.#running;
+    }
+    set concurrency(value) {
+        this.#concurrency = value;
+        this.#run();
+    }
+    get concurrency() {
+        return this.#concurrency;
+    }
+}
+
+export { Queue, UploadClient, UploadClientError, UploadcareFile, UploadcareGroup, UploadcareNetworkError, base, fromUrl, fromUrlStatus, getUserAgent$1 as getUserAgent, group, groupInfo, info, multipartComplete, multipartStart, multipartUpload, uploadDirect, uploadFile, uploadFileGroup, uploadFromUploaded, uploadFromUrl, uploadMultipart };

package/dist/esm/index.react-native.d.mts

@@ -472,6 +472,16 @@ export declare class UploadClient {
 	uploadFile(data: SupportedFileInput | Url | Uuid, options?: Partial<FileFromOptions>): Promise<UploadcareFile>;
 	uploadFileGroup(data: SupportedFileInput[] | Url[] | Uuid[], options?: Partial<FileFromOptions & GroupFromOptions>): Promise<UploadcareGroup>;
 }
+export type Task<T = unknown> = () => Promise<T>;
+export declare class Queue {
+	#private;
+	constructor(concurrency: number);
+	add<T>(task: Task<T>): Promise<T>;
+	get pending(): number;
+	get running(): number;
+	set concurrency(value: number);
+	get concurrency(): number;
+}
 export type Headers = {
 	[key: string]: string | string[] | undefined;
 };

package/dist/esm/index.react-native.mjs

@@ -404,7 +404,7 @@ const getUrl = (base, path, query) => {
     return url.toString();
 };
 
-var version = '6.5.0';
+var version = '6.6.0';
 
 const LIBRARY_NAME = 'UploadcareUploadClient';
 const LIBRARY_VERSION = version;
@@ -1682,4 +1682,59 @@ class UploadClient {
     }
 }
 
-export { UploadClient, UploadClientError, UploadcareFile, UploadcareGroup, UploadcareNetworkError, base, fromUrl, fromUrlStatus, getUserAgent$1 as getUserAgent, group, groupInfo, info, multipartComplete, multipartStart, multipartUpload, uploadDirect, uploadFile, uploadFileGroup, uploadFromUploaded, uploadFromUrl, uploadMultipart };
+class Queue {
+    #concurrency = 1;
+    #pending = [];
+    #running = 0;
+    #resolvers = new WeakMap();
+    #rejectors = new WeakMap();
+    constructor(concurrency) {
+        this.#concurrency = concurrency;
+    }
+    #run() {
+        const tasksLeft = this.#concurrency - this.#running;
+        for (let i = 0; i < tasksLeft; i++) {
+            const task = this.#pending.shift();
+            if (!task) {
+                return;
+            }
+            const resolver = this.#resolvers.get(task);
+            const rejector = this.#rejectors.get(task);
+            if (!resolver || !rejector)
+                throw new Error('Unexpected behavior: resolver or rejector is undefined');
+            this.#running += 1;
+            task()
+                .finally(() => {
+                this.#resolvers.delete(task);
+                this.#rejectors.delete(task);
+                this.#running -= 1;
+                this.#run();
+            })
+                .then((value) => resolver(value))
+                .catch((error) => rejector(error));
+        }
+    }
+    add(task) {
+        return new Promise((resolve, reject) => {
+            this.#resolvers.set(task, resolve);
+            this.#rejectors.set(task, reject);
+            this.#pending.push(task);
+            this.#run();
+        });
+    }
+    get pending() {
+        return this.#pending.length;
+    }
+    get running() {
+        return this.#running;
+    }
+    set concurrency(value) {
+        this.#concurrency = value;
+        this.#run();
+    }
+    get concurrency() {
+        return this.#concurrency;
+    }
+}
+
+export { Queue, UploadClient, UploadClientError, UploadcareFile, UploadcareGroup, UploadcareNetworkError, base, fromUrl, fromUrlStatus, getUserAgent$1 as getUserAgent, group, groupInfo, info, multipartComplete, multipartStart, multipartUpload, uploadDirect, uploadFile, uploadFileGroup, uploadFromUploaded, uploadFromUrl, uploadMultipart };

package/dist/index.d.ts

@@ -472,6 +472,16 @@ export declare class UploadClient {
 	uploadFile(data: SupportedFileInput | Url | Uuid, options?: Partial<FileFromOptions>): Promise<UploadcareFile>;
 	uploadFileGroup(data: SupportedFileInput[] | Url[] | Uuid[], options?: Partial<FileFromOptions & GroupFromOptions>): Promise<UploadcareGroup>;
 }
+export type Task<T = unknown> = () => Promise<T>;
+export declare class Queue {
+	#private;
+	constructor(concurrency: number);
+	add<T>(task: Task<T>): Promise<T>;
+	get pending(): number;
+	get running(): number;
+	set concurrency(value: number);
+	get concurrency(): number;
+}
 export type Headers = {
 	[key: string]: string | string[] | undefined;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uploadcare/upload-client",
-  "version": "6.5.0",
+  "version": "6.6.0",
   "description": "Library for work with Uploadcare Upload API",
   "type": "module",
   "module": "./dist/esm/index.node.mjs",
@@ -90,7 +90,7 @@
     "koa-body": "5.0.0",
     "mock-socket": "9.0.3",
     "start-server-and-test": "1.14.0",
-    "@uploadcare/api-client-utils": "^6.5.0",
+    "@uploadcare/api-client-utils": "^6.6.0",
     "chalk": "^4.1.2"
   },
   "dependencies": {