@uploadcare/upload-client 2.0.0-alpha.9 → 2.0.0

package/dist/types.d.ts

@@ -105,7 +105,8 @@ export declare type CustomUserAgentOptions = {
 	languageName: string;
 	integration?: string;
 };
-export declare type CustomUserAgent = string | ((options: CustomUserAgentOptions) => string);
+export declare type CustomUserAgentFn = (options: CustomUserAgentOptions) => string;
+export declare type CustomUserAgent = string | CustomUserAgentFn;
 export declare type BrowserFile = Blob | File;
 export declare type NodeFile = Buffer;
 export declare type BaseResponse = {
@@ -177,6 +178,7 @@ export declare type StatusProgressResponse = {
 export declare type StatusErrorResponse = {
 	status: Status.Error;
 	error: string;
+	errorCode: string;
 };
 export declare type StatusSuccessResponse = {
 	status: Status.Success;
@@ -246,8 +248,10 @@ export declare type MultipartStartResponse = {
 };
 declare function multipartStart(size: number, { publicKey, contentType, fileName, multipartChunkSize, baseURL, secureSignature, secureExpire, store, signal, source, integration, userAgent, retryThrottledRequestMaxTimes }: MultipartStartOptions): Promise<MultipartStartResponse>;
 export declare type MultipartUploadOptions = {
+	publicKey?: string;
 	signal?: AbortSignal;
 	onProgress?: ProgressCallback;
+	integration?: string;
 	retryThrottledRequestMaxTimes?: number;
 };
 export declare type MultipartUploadResponse = {
@@ -270,6 +274,7 @@ declare class UploadcareFile {
 	readonly size: null | number;
 	readonly isStored: null | boolean;
 	readonly isImage: null | boolean;
+	readonly mimeType: null | string;
 	readonly cdnUrl: null | string;
 	readonly cdnUrlModifiers: null | string;
 	readonly originalUrl: null | string;
@@ -282,6 +287,62 @@ declare class UploadcareFile {
 		fileName?: string;
 	});
 }
+export declare type FromObjectOptions = {
+	publicKey: string;
+	fileName?: string;
+	baseURL?: string;
+	secureSignature?: string;
+	secureExpire?: string;
+	store?: boolean;
+	signal?: AbortSignal;
+	onProgress?: ProgressCallback;
+	source?: string;
+	integration?: string;
+	userAgent?: CustomUserAgent;
+	retryThrottledRequestMaxTimes?: number;
+	baseCDN?: string;
+};
+declare const uploadFromObject: (file: NodeFile | BrowserFile, { publicKey, fileName, baseURL, secureSignature, secureExpire, store, signal, onProgress, source, integration, userAgent, retryThrottledRequestMaxTimes, baseCDN }: FromObjectOptions) => Promise<UploadcareFile>;
+export declare type UploadFromUrlOptions = {
+	baseCDN?: string;
+	onProgress?: ProgressCallback;
+	pusherKey?: string;
+} & FromUrlOptions;
+export declare const uploadFromUrl: (sourceUrl: string, { publicKey, fileName, baseURL, baseCDN, checkForUrlDuplicates, saveUrlForRecurrentUploads, secureSignature, secureExpire, store, signal, onProgress, source, integration, userAgent, retryThrottledRequestMaxTimes, pusherKey }: UploadFromUrlOptions) => Promise<UploadcareFile>;
+export declare type FromUploadedOptions = {
+	publicKey: string;
+	fileName?: string;
+	baseURL?: string;
+	signal?: AbortSignal;
+	onProgress?: ProgressCallback;
+	source?: string;
+	integration?: string;
+	userAgent?: CustomUserAgent;
+	retryThrottledRequestMaxTimes?: number;
+	baseCDN?: string;
+};
+export declare const uploadFromUploaded: (uuid: Uuid, { publicKey, fileName, baseURL, signal, onProgress, source, integration, userAgent, retryThrottledRequestMaxTimes, baseCDN }: FromUploadedOptions) => Promise<UploadcareFile>;
+export declare type MultipartOptions = {
+	publicKey: string;
+	contentType?: string;
+	multipartChunkSize?: number;
+	fileName?: string;
+	fileSize?: number;
+	baseURL?: string;
+	secureSignature?: string;
+	secureExpire?: string;
+	store?: boolean;
+	signal?: AbortSignal;
+	onProgress?: ProgressCallback;
+	source?: string;
+	integration?: string;
+	userAgent?: CustomUserAgent;
+	retryThrottledRequestMaxTimes?: number;
+	maxConcurrentRequests?: number;
+	multipartMaxAttempts?: number;
+	baseCDN?: string;
+};
+export declare const uploadMultipart: (file: NodeFile | BrowserFile, { publicKey, fileName, fileSize, baseURL, secureSignature, secureExpire, store, signal, onProgress, source, integration, userAgent, retryThrottledRequestMaxTimes, contentType, multipartChunkSize, maxConcurrentRequests, multipartMaxAttempts, baseCDN }: MultipartOptions) => Promise<UploadcareFile>;
 export declare type FileFromOptions = {
 	publicKey: string;
 	fileName?: string;
@@ -297,9 +358,17 @@ export declare type FileFromOptions = {
 	retryThrottledRequestMaxTimes?: number;
 	contentType?: string;
 	multipartChunkSize?: number;
+	multipartMaxAttempts?: number;
+	maxConcurrentRequests?: number;
 	baseCDN?: string;
+	checkForUrlDuplicates?: boolean;
+	saveUrlForRecurrentUploads?: boolean;
+	pusherKey?: string;
 };
-declare function uploadFile(data: NodeFile | BrowserFile | Url | Uuid, { publicKey, fileName, baseURL, secureSignature, secureExpire, store, signal, onProgress, source, integration, userAgent, retryThrottledRequestMaxTimes, contentType, multipartChunkSize, baseCDN }: FileFromOptions): Promise<UploadcareFile>;
+/**
+ * Uploads file from provided data.
+ */
+export declare function uploadFile(data: NodeFile | BrowserFile | Url | Uuid, { publicKey, fileName, baseURL, secureSignature, secureExpire, store, signal, onProgress, source, integration, userAgent, retryThrottledRequestMaxTimes, contentType, multipartChunkSize, multipartMaxAttempts, maxConcurrentRequests, baseCDN, checkForUrlDuplicates, saveUrlForRecurrentUploads, pusherKey }: FileFromOptions): Promise<UploadcareFile>;
 declare class UploadcareGroup {
 	readonly uuid: GroupId;
 	readonly filesCount: string;
@@ -347,8 +416,8 @@ export {
 	multipartComplete as multipartComplete,
 	multipartStart as multipartStart,
 	multipartUpload as multipartUpload,
-	uploadFile as uploadFile,
 	uploadFileGroup as uploadFileGroup,
+	uploadFromObject as uploadBase,
 };
 
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uploadcare/upload-client",
-  "version": "2.0.0-alpha.9",
+  "version": "2.0.0",
   "description": "Library for work with Uploadcare Upload API",
   "type": "module",
   "main": "dist/index.cjs",
@@ -21,6 +21,12 @@
       "import": "./dist/index.js"
     }
   },
+  "react-native": {
+    "./lib/request/request.node.js": "./lib/request/request.browser.js",
+    "./lib/tools/getFormData.node.js": "./lib/tools/getFormData.react-native.js",
+    "./lib/tools/sockets.node.js": "./lib/tools/sockets.browser.js",
+    "./lib/uploadFile/prepareChunks.node.js": "./lib/uploadFile/prepareChunks.react-native.js"
+  },
   "scripts": {
     "check-env-vars": "node ./checkvars.js",
     "mock:start": "node --loader ts-node/esm.mjs ./mock-server/server.ts --silent",
@@ -56,47 +62,47 @@
     "cdn"
   ],
   "devDependencies": {
-    "@koa/cors": "3.1.0",
-    "@koa/router": "8.0.8",
     "@rollup/plugin-alias": "^3.1.1",
     "@rollup/plugin-node-resolve": "^8.4.0",
+    "@types/ws": "8.2.0",
+    "dts-bundle-generator": "5.4.0",
+    "prettier": "2.2.1",
+    "rollup": "^2.23.0",
+    "rollup-plugin-typescript2": "^0.27.1",
+    "typescript": "^3.9.7",
+    "@koa/cors": "3.1.0",
+    "@koa/router": "10.0.0",
     "@types/form-data": "2.5.0",
-    "@types/jest": "26.0.9",
-    "@types/koa": "2.11.3",
-    "@types/node": "12.12.54",
+    "@types/jest": "26.0.14",
+    "@types/koa": "2.11.4",
+    "@types/node": "12.12.67",
     "@types/promise": "7.1.30",
-    "@types/ws": "7.2.6",
-    "@typescript-eslint/eslint-plugin": "2.34.0",
-    "@typescript-eslint/parser": "2.34.0",
+    "@typescript-eslint/eslint-plugin": "5.3.1",
+    "@typescript-eslint/parser": "5.3.1",
     "chalk": "4.1.0",
     "data-uri-to-buffer": "3.0.1",
     "dataurl-to-blob": "0.0.1",
     "dotenv": "8.2.0",
-    "dts-bundle-generator": "5.4.0",
-    "eslint": "7.6.0",
-    "eslint-config-prettier": "6.11.0",
-    "eslint-plugin-prettier": "3.1.4",
-    "jest": "26.2.2",
-    "jest-environment-jsdom": "26.2.0",
-    "jest-websocket-mock": "2.1.0",
+    "eslint": "8.2.0",
+    "eslint-config-prettier": "8.3.0",
+    "eslint-plugin-prettier": "4.0.0",
+    "jest": "26.5.3",
+    "jest-environment-jsdom": "26.5.2",
+    "jest-websocket-mock": "2.2.0",
     "koa": "2.13.0",
     "koa-add-trailing-slashes": "2.0.1",
     "koa-body": "4.2.0",
     "mock-socket": "9.0.3",
-    "prettier": "1.19.1",
-    "prettier-config-standard": "1.0.1",
+    "prettier-config-standard": "4.0.0",
     "rimraf": "3.0.2",
-    "rollup": "^2.23.0",
-    "rollup-plugin-typescript2": "^0.27.1",
-    "shipjs": "0.20.1",
-    "start-server-and-test": "1.11.3",
-    "ts-jest": "26.1.4",
-    "ts-node": "8.10.2",
-    "typescript": "^3.9.7"
+    "shipjs": "0.24.0",
+    "start-server-and-test": "1.11.7",
+    "ts-jest": "26.4.1",
+    "ts-node": "9.1.1"
   },
   "dependencies": {
     "abort-controller": "^3.0.0",
     "form-data": "^4.0.0",
-    "ws": "^7.2.1"
+    "ws": "^8.2.3"
   }
 }

package/CHANGELOG.md

@@ -1,243 +0,0 @@
-## [1.1.2](https://github.com/uploadcare/uploadcare-upload-client/compare/v1.1.1...v1.1.2) (2020-04-20)
-
-
-### Bug Fixes
-
-* **multipart:** implement retry for part uploading ([#253](https://github.com/uploadcare/uploadcare-upload-client/issues/253)) ([e2330bb](https://github.com/uploadcare/uploadcare-upload-client/commit/e2330bb37ea75b2d82c3258696b5d18cf719eae5))
-* **multipart:** add is ready pool for mulipart upload ([#254](https://github.com/uploadcare/uploadcare-upload-client/issues/254)) ([fe7ca2a](https://github.com/uploadcare/uploadcare-upload-client/commit/fe7ca2a0bbee7b24de2a792669ec33691cb2fd0c))
-* **multipart:** implement multipart progress for node ([#252](https://github.com/uploadcare/uploadcare-upload-client/issues/252)) ([b60eb83](https://github.com/uploadcare/uploadcare-upload-client/commit/b60eb831ff966a4c6a80f2ee9d72ce3b76659d56))
-* **multipart:** use browser contentType if option is not passed ([#251](https://github.com/uploadcare/uploadcare-upload-client/issues/251)) ([f5ab80a](https://github.com/uploadcare/uploadcare-upload-client/commit/f5ab80a295cd6e4fc59e426d9d73086999bf4197))
-* **multipart:** use browser filename if option is not passed ([#250](https://github.com/uploadcare/uploadcare-upload-client/issues/250)) ([749e4a9](https://github.com/uploadcare/uploadcare-upload-client/commit/749e4a988b7d10ee9368433a4ffa076471a4d3e3))
-
-
-## [1.1.1](https://github.com/uploadcare/uploadcare-upload-client/compare/v1.1.0...v1.1.1) (2020-03-16)
-
-
-### Bug Fixes
-
-* add is ready poll in `uploadFromUrl` ([#238](https://github.com/uploadcare/uploadcare-upload-client/issues/238)) ([dd0202d](https://github.com/uploadcare/uploadcare-upload-client/commit/dd0202d5ef2c787a63d345731ea2ccc39ecca70e))
-
-
-
-# [1.1.0](https://github.com/uploadcare/uploadcare-upload-client/compare/v1.0.1...v1.1.0) (2020-03-03)
-
-
-### Features
-
-* implement push strategy with sockets for `uploadFromUrl` ([#222](https://github.com/uploadcare/uploadcare-upload-client/issues/222)) ([4cafe97](https://github.com/uploadcare/uploadcare-upload-client/commit/4cafe9759ebfe1f54b0e6d2f9cf2cffa36ec3283))
-* add deferred disconnect for push strategy ([#229](https://github.com/uploadcare/uploadcare-upload-client/issues/229)) ([a9901f7](https://github.com/uploadcare/uploadcare-upload-client/commit/a9901f74aa1512471b3f4bd470ccc794eb31dac0))
-* add strong typed event emitter ([#217](https://github.com/uploadcare/uploadcare-upload-client/issues/217)) ([35b9eef](https://github.com/uploadcare/uploadcare-upload-client/commit/35b9eef22ae0638d52915a2338e3c3978e3d6f2b))
-* add custom race function ([#177](https://github.com/uploadcare/uploadcare-upload-client/issues/177)) ([219c02a](https://github.com/uploadcare/uploadcare-upload-client/commit/219c02aceb233886383e6d66c5ecdfbd5a1626ea))
-
-
-### Bug Fixes
-
-* make `fileName` optional and remove it from default settings ([#233](https://github.com/uploadcare/uploadcare-upload-client/issues/233)) ([a28d181](https://github.com/uploadcare/uploadcare-upload-client/commit/a28d181e5c412f6ff2aeee2e7ae02a7ae848c8a2))
-* remove timeout from `uploadFromUrl` function ([#226](https://github.com/uploadcare/uploadcare-upload-client/issues/226)) ([76db2e4](https://github.com/uploadcare/uploadcare-upload-client/commit/76db2e4c607164afcaf07132789348927ea65577))
-* use direct import for CancelController and rename callback to stopRace ([#216](https://github.com/uploadcare/uploadcare-upload-client/issues/216)) ([ea4ef7a](https://github.com/uploadcare/uploadcare-upload-client/commit/ea4ef7ac291ed1503e359901a315239563b53e83))
-
-
-## [1.0.1](https://github.com/uploadcare/uploadcare-upload-client/compare/v1.0.0...v1.0.1) (2020-01-13)
-
-
-### Bug Fixes
-
-* **deps:** update dependency form-data to v3 ([#130](https://github.com/uploadcare/uploadcare-upload-client/issues/130)) ([1ece271](https://github.com/uploadcare/uploadcare-upload-client/commit/1ece271d8583ba257011d16b3f1930ad29329a96))
-
-
-
-# [1.0.0](https://github.com/uploadcare/uploadcare-upload-client/compare/v1.0.0-alpha.5...v1.0.0) (2019-12-23)
-
-### Changed
-
-- All methods return a `Promise` now instead of `ThenableInterface`
-- `SettingsInterface` was renamed to `Settings`
-- `fileFrom` was renamed to `uploadFile`.
-- `groupFrom` was renamed to `uploadFileGroup`.
-- `request` low-level API method is not exported outside now.
-- Method `setSettings` of `UploadClient` was renamed to `updateSettings`.
-- Methods (`base`, `fromUrl`, `fromUrlStatus`, `group`,
-  `groupInfo`, `info`, `multipartStart`, `multipartUpload`,
-  `multipartComplete`, `multipart`, `uploadFile`, `uploadGroup`) were exported
-  from `index.ts` to make the tree shaking better.
-- Methods (`base`, `fromUrl`, `fromUrlStatus`, `group`,
-  `groupInfo`, `info`, `multipartStart`, `multipartUpload`,
-  `multipartComplete`, `multipart`, `uploadFile`, `uploadGroup`) accept
-  `options` instead of `settings` as a second argument.
-- `UploadClient` now contains all low-level API methods (`base`,
-  `fromUrl`, `fromUrlStatus`, `group`, `groupInfo`, `info`,
-  `multipartStart`, `multipartUpload`, `multipartComplete`, `multipart`,
-  `fileFrom`, `groupFrom`).
-- `UploadcareGroup` files now contain `UploadcareFile[]`, but not `FileInfo[]`.
-- `README.md` was updated according to library API.
-- `FileData` became `NodeFile` and `BrowserFile`.
-
-### Removed
-
-- `UploadAPI` class.
-- `Thenable`, `CancelableThenable`, `BaseThenable`, `Upload` classes
-  implementing respective interfaces.
-- `onReady`, `onUploaded` callbacks.
-- `addUpdateSettingsListener` and `removeUpdateSettingsListener` from
-  `UploadClientInterface`.
-- `from` param of `uploadFile` and `uploadFileGroup`.
-- `FileFromEnum` and `GroupFromEnum`.
-
-### Added
-
-- `CancelController` to make API calls cancellable. See README for how
-  to use this feature. ([#77](https://github.com/uploadcare/uploadcare-upload-client/issues/77))
-
-## [1.0.0-alpha.5]
-
-### Added
-
-- Support of multipart and big files uploading: `multipartStart`,
-  `multipartUpload`, and `multipartComplete` methods to `UploadAPI`.
-- Support of canceling uploads and handling them for all API methods
-  (`info`, `fromUrl`, `fromUrlStatus`, `group`, `groupInfo`).
-- `DefaultSettingsInterface` with required properties.
-- `pollingTimeoutMilliseconds` to `SettingsInterface`.
-  Now you can adjust the timeout for checking is file ready,
-  and checking is file being uploaded from URL.
-- `maxConcurrentRequests` setting that allows you to specify the number
-  of concurrent requests.
-
-### Changed
-
-- `FileFrom` enum was renamed to `FileFromEnum`.
-- `GroupFrom` enum was renamed to `GroupFromEnum`.
-- `Settings` was renamed to `SettingsInterface`.
-- `FileInfo` was renamed to `FileInfoInterface`.
-- `GroupInfo` was renamed to `GroupInfoInfoInterface`.
-- `OriginalImageInfo` was renamed to `OriginalImageInfoInterface`.
-- `RequestOptions` was renamed to `RequestOptionsInterface`.
-- `ProgressStatus` was renamed to `ProgressStatusInterface`.
-- `Audio` type was renamed to `AudioInterface`.
-- `Video` type was renamed to `VideoInterface`.
-- `ErrorRequestInfo` type was renamed to `ErrorRequestInfoInterface`.
-- `ErrorResponseInfoInfo` type was renamed to `ErrorResponseInfoInterface`.
-- `ProgressState` was renamed to `ProgressStateEnum`.
-- `ProgressParams` was renamed to `ProgressParamsInterface`.
-- `base` method of Upload API now returns `BaseThenableInterface<BaseResponse>`
-  instead of `DirectUploadInterface`.
-- `info`, `fromUrl`, `fromUrlStatus`, `group`, `groupInfo` now returns
-  `CancelableThenableInterface`.
-- Progress is now calculated from 0 to 1 instead of 0 to 100
-
-### Fixed
-
-- Example with `directUpload.onProgress` in `README.md`.
-- All tests are passing now.
-- Mock server tests are passing now.
-
-### Removed
-
-- `DirectUploadInterface` was removed in favor of `BaseThenableInterface<BaseResponse>`.
-- `BaseProgress` was removed in favor of native `ProgressEvent`.
-- `InfoResponse` was removed in favor of `FileInfoInterface`.
-- Old code in folder `./.back`.
-
-[1.0.0-alpha.5]: https://github.com/uploadcare/uploadcare-upload-client/compare/v1.0.0-alpha.4...v1.0.0-alpha.5
-
-## [1.0.0-alpha.4]
-
-### Added
-
-- Wrappers for group paths of Upload API (`group`, `groupInfo`).
-- The high-level function for group uploading, aka filesGroupFrom.
-- Uploading progress for Node.js in the `base` method.
-
-### Changed
-
-- `UploadFromInterface` was renamed to `FileUploadInterface`.
-- `FileProgress` was renamed to `ProgressParams`.
-- `UploadcareFile` was renamed to `UploadcareFileInterface`.
-
-[1.0.0-alpha.4]: https://github.com/uploadcare/uploadcare-upload-client/compare/v1.0.0-alpha.3...v1.0.0-alpha.4
-
-## [1.0.0-alpha.3]
-
-### Added
-
-- Support `fileFrom` 'uploaded' file (`uuid`).
-- Support of `waiting` status from `/from_url/status/` endpoint.
-- Export some main types from the `index.ts` file.
-  So you can import them now directly from `@uploadcare/upload-client`.
-- Throttling for `request`.
-- `retryThrottledMaxTimes` param to set count of max retries after
-  throttled request (1 by default).
-- `Uuid` type.
-- Mock server for local testing.
-
-### Fixed
-
-- The default timeout for polling functions increased from 3s to 10s.
-- Removed restrictions for timeout and interval.
-
-[1.0.0-alpha.3]: https://github.com/uploadcare/uploadcare-upload-client/compare/v1.0.0-alpha.2...v1.0.0-alpha.3
-
-## [1.0.0-alpha.2]
-
-### Changed
-
-- The project was moved from Flow notations to TypeScript.
-- The `base` function now returns an object that implements
-  `DirectUploadInterface`.
-- The `fileFrom` function now returns an object that implements
-  `UploadFromInterface`.
-- The `UCFile` type renamed to `UploadcareFile`.
-- The progress of `fileFrom` now based on the `UploadingProgress` type.
-
-### Added
-
-- Low-level request wrappers for `/from_url/` and `/from_url/status/`
-  paths of Upload API.
-- Settings: the support of setting `baseCDN`, `checkForUrlDuplicates`,
-  `saveUrlForRecurrentUploads`.
-
-[1.0.0-alpha.2]: https://github.com/uploadcare/uploadcare-upload-client/compare/v1.0.0-alpha.1...v1.0.0-alpha.2
-
-## [1.0.0-alpha.1]
-
-### Fixed
-
-- Use the version from the `package.json` file to create Uploadcare User
-  Agent.
-
-### Changed
-
-- The `base` function returns `thenable` object called `DirectUpload`
-  instead of using the `promise` property.
-- The `fileFrom` function returns `thenable` object called `FilePromise`
-  instead of using the `promise` property.
-- The `FileInfo` type renamed to `UCFile` and updated.
-- The `FilePromise` resolved with an object of the `UploadcareFile` type.
-- The progress of `fileFrom` now based on the `FilePromiseProgress` type.
-- Updated the `InfoResponse` type.
-
-### Added
-
-- The `checkFileIsReady` function to check if the file is ready on the CDN.
-- New properties for the object that the `fileFrom` function returns:
-  `onUploaded`, `onReady`.
-- The `camelizeKeys` function for inner usage.
-- The `baseCDN` default setting
-
-[1.0.0-alpha.1]: https://github.com/uploadcare/uploadcare-upload-client/compare/v1.0.0-alpha...v1.0.0-alpha.1
-
-## 1.0.0-alpha
-
-The first public alpha release.
-
-### Added
-
-- The `request` function to request to any path of [Upload API][upload-api].
-- Low-level request wrappers for `/base/` and `/info/` paths of Upload API.
-- `UploadClient` class with settings and `fileFrom` method that supports
-  only direct uploads now.
-- Support of following Uploadcare Settings: `publicKey`, `baseUrl`,
-  `doNotStore`, `integration`, `secureExpire`, `secureSignature`.
-- Test environment for both Node.js and browsers
-
-[upload-api]: https://uploadcare.com/docs/api_reference/upload/