@uploadcare/upload-client 3.1.0 → 4.0.0

package/dist/types.d.ts

@@ -1,6 +1,4 @@
-// Generated by dts-bundle-generator v5.4.0
-
-/// <reference types="node" />
+// Generated by dts-bundle-generator v6.9.0
 
 import NodeFormData from 'form-data';
 
@@ -152,6 +150,7 @@ export declare type BaseOptions = {
 	secureSignature?: string;
 	secureExpire?: string;
 	store?: boolean;
+	contentType?: string;
 	signal?: AbortSignal;
 	onProgress?: ProgressCallback;
 	source?: string;
@@ -160,7 +159,11 @@ export declare type BaseOptions = {
 	retryThrottledRequestMaxTimes?: number;
 	metadata?: Metadata;
 };
-declare function base(file: NodeFile | BrowserFile, { publicKey, fileName, baseURL, secureSignature, secureExpire, store, signal, onProgress, source, integration, userAgent, retryThrottledRequestMaxTimes, metadata }: BaseOptions): Promise<BaseResponse>;
+/**
+ * Performs file uploading request to Uploadcare Upload API.
+ * Can be canceled and has progress.
+ */
+export function base(file: NodeFile | BrowserFile, { publicKey, fileName, contentType, baseURL, secureSignature, secureExpire, store, signal, onProgress, source, integration, userAgent, retryThrottledRequestMaxTimes, metadata }: BaseOptions): Promise<BaseResponse>;
 declare enum TypeEnum {
 	Token = "token",
 	FileInfo = "file_info"
@@ -190,7 +193,10 @@ export declare type FromUrlOptions = {
 	retryThrottledRequestMaxTimes?: number;
 	metadata?: Metadata;
 };
-declare function fromUrl(sourceUrl: Url, { publicKey, baseURL, store, fileName, checkForUrlDuplicates, saveUrlForRecurrentUploads, secureSignature, secureExpire, source, signal, integration, userAgent, retryThrottledRequestMaxTimes, metadata }: FromUrlOptions): Promise<FromUrlSuccessResponse>;
+/**
+ * Uploading files from URL.
+ */
+export function fromUrl(sourceUrl: Url, { publicKey, baseURL, store, fileName, checkForUrlDuplicates, saveUrlForRecurrentUploads, secureSignature, secureExpire, source, signal, integration, userAgent, retryThrottledRequestMaxTimes, metadata }: FromUrlOptions): Promise<FromUrlSuccessResponse>;
 declare enum Status {
 	Unknown = "unknown",
 	Waiting = "waiting",
@@ -227,7 +233,10 @@ export declare type FromUrlStatusOptions = {
 	userAgent?: CustomUserAgent;
 	retryThrottledRequestMaxTimes?: number;
 };
-declare function fromUrlStatus(token: Token, { publicKey, baseURL, signal, integration, userAgent, retryThrottledRequestMaxTimes }?: FromUrlStatusOptions): Promise<FromUrlStatusResponse>;
+/**
+ * Checking upload status and working with file tokens.
+ */
+export function fromUrlStatus(token: Token, { publicKey, baseURL, signal, integration, userAgent, retryThrottledRequestMaxTimes }?: FromUrlStatusOptions): Promise<FromUrlStatusResponse>;
 export declare type GroupOptions = {
 	publicKey: string;
 	baseURL?: string;
@@ -240,7 +249,10 @@ export declare type GroupOptions = {
 	userAgent?: CustomUserAgent;
 	retryThrottledRequestMaxTimes?: number;
 };
-declare function group(uuids: Uuid[], { publicKey, baseURL, jsonpCallback, secureSignature, secureExpire, signal, source, integration, userAgent, retryThrottledRequestMaxTimes }: GroupOptions): Promise<GroupInfo>;
+/**
+ * Create files group.
+ */
+export function group(uuids: Uuid[], { publicKey, baseURL, jsonpCallback, secureSignature, secureExpire, signal, source, integration, userAgent, retryThrottledRequestMaxTimes }: GroupOptions): Promise<GroupInfo>;
 export declare type GroupInfoOptions = {
 	publicKey: string;
 	baseURL?: string;
@@ -250,7 +262,10 @@ export declare type GroupInfoOptions = {
 	userAgent?: CustomUserAgent;
 	retryThrottledRequestMaxTimes?: number;
 };
-declare function groupInfo(id: GroupId, { publicKey, baseURL, signal, source, integration, userAgent, retryThrottledRequestMaxTimes }: GroupInfoOptions): Promise<GroupInfo>;
+/**
+ * Get info about group.
+ */
+export function groupInfo(id: GroupId, { publicKey, baseURL, signal, source, integration, userAgent, retryThrottledRequestMaxTimes }: GroupInfoOptions): Promise<GroupInfo>;
 export declare type InfoOptions = {
 	publicKey: string;
 	baseURL?: string;
@@ -260,7 +275,10 @@ export declare type InfoOptions = {
 	userAgent?: CustomUserAgent;
 	retryThrottledRequestMaxTimes?: number;
 };
-declare function info(uuid: Uuid, { publicKey, baseURL, signal, source, integration, userAgent, retryThrottledRequestMaxTimes }: InfoOptions): Promise<FileInfo>;
+/**
+ * Returns a JSON dictionary holding file info.
+ */
+export function info(uuid: Uuid, { publicKey, baseURL, signal, source, integration, userAgent, retryThrottledRequestMaxTimes }: InfoOptions): Promise<FileInfo>;
 export declare type MultipartStartOptions = {
 	publicKey: string;
 	contentType?: string;
@@ -282,7 +300,10 @@ export declare type MultipartStartResponse = {
 	parts: MultipartPart[];
 	uuid: Uuid;
 };
-declare function multipartStart(size: number, { publicKey, contentType, fileName, multipartChunkSize, baseURL, secureSignature, secureExpire, store, signal, source, integration, userAgent, retryThrottledRequestMaxTimes, metadata }: MultipartStartOptions): Promise<MultipartStartResponse>;
+/**
+ * Start multipart uploading.
+ */
+export function multipartStart(size: number, { publicKey, contentType, fileName, multipartChunkSize, baseURL, secureSignature, secureExpire, store, signal, source, integration, userAgent, retryThrottledRequestMaxTimes, metadata }: MultipartStartOptions): Promise<MultipartStartResponse>;
 export declare type MultipartUploadOptions = {
 	publicKey?: string;
 	signal?: AbortSignal;
@@ -293,7 +314,10 @@ export declare type MultipartUploadOptions = {
 export declare type MultipartUploadResponse = {
 	code?: number;
 };
-declare function multipartUpload(part: NodeFile | BrowserFile, url: MultipartPart, { signal, onProgress }: MultipartUploadOptions): Promise<MultipartUploadResponse>;
+/**
+ * Complete multipart uploading.
+ */
+export function multipartUpload(part: NodeFile | BrowserFile, url: MultipartPart, { signal, onProgress }: MultipartUploadOptions): Promise<MultipartUploadResponse>;
 export declare type MultipartCompleteOptions = {
 	publicKey: string;
 	baseURL?: string;
@@ -303,7 +327,10 @@ export declare type MultipartCompleteOptions = {
 	userAgent?: CustomUserAgent;
 	retryThrottledRequestMaxTimes?: number;
 };
-declare function multipartComplete(uuid: Uuid, { publicKey, baseURL, source, signal, integration, userAgent, retryThrottledRequestMaxTimes }: MultipartCompleteOptions): Promise<FileInfo>;
+/**
+ * Complete multipart uploading.
+ */
+export function multipartComplete(uuid: Uuid, { publicKey, baseURL, source, signal, integration, userAgent, retryThrottledRequestMaxTimes }: MultipartCompleteOptions): Promise<FileInfo>;
 export declare class UploadcareFile {
 	readonly uuid: Uuid;
 	readonly name: null | string;
@@ -312,26 +339,26 @@ export declare class UploadcareFile {
 	readonly isImage: null | boolean;
 	readonly mimeType: null | string;
 	readonly cdnUrl: null | string;
-	readonly cdnUrlModifiers: null | string;
-	readonly originalUrl: null | string;
+	readonly s3Url: null | string;
 	readonly originalFilename: null | string;
 	readonly imageInfo: null | ImageInfo;
 	readonly videoInfo: null | VideoInfo;
 	readonly contentInfo: null | ContentInfo;
 	readonly metadata: null | Metadata;
-	constructor(fileInfo: FileInfo, { baseCDN, defaultEffects, fileName }: {
+	readonly s3Bucket: null | string;
+	constructor(fileInfo: FileInfo, { baseCDN, fileName }: {
 		baseCDN?: string;
-		defaultEffects?: string;
 		fileName?: string;
 	});
 }
-export declare type FromObjectOptions = {
+export declare type DirectOptions = {
 	publicKey: string;
 	fileName?: string;
 	baseURL?: string;
 	secureSignature?: string;
 	secureExpire?: string;
 	store?: boolean;
+	contentType?: string;
 	signal?: AbortSignal;
 	onProgress?: ProgressCallback;
 	source?: string;
@@ -341,7 +368,7 @@ export declare type FromObjectOptions = {
 	baseCDN?: string;
 	metadata?: Metadata;
 };
-declare const uploadFromObject: (file: NodeFile | BrowserFile, { publicKey, fileName, baseURL, secureSignature, secureExpire, store, signal, onProgress, source, integration, userAgent, retryThrottledRequestMaxTimes, baseCDN, metadata }: FromObjectOptions) => Promise<UploadcareFile>;
+export declare const uploadDirect: (file: NodeFile | BrowserFile, { publicKey, fileName, baseURL, secureSignature, secureExpire, store, contentType, signal, onProgress, source, integration, userAgent, retryThrottledRequestMaxTimes, baseCDN, metadata }: DirectOptions) => Promise<UploadcareFile>;
 export declare type UploadFromUrlOptions = {
 	baseCDN?: string;
 	onProgress?: ProgressCallback;
@@ -424,11 +451,10 @@ export declare class UploadcareGroup {
 	constructor(groupInfo: GroupInfo, files: UploadcareFile[]);
 }
 export declare type GroupFromOptions = {
-	defaultEffects?: string;
 	jsonpCallback?: string;
 };
-declare function uploadFileGroup(data: (NodeFile | BrowserFile)[] | Url[] | Uuid[], { publicKey, fileName, baseURL, secureSignature, secureExpire, store, signal, onProgress, source, integration, userAgent, retryThrottledRequestMaxTimes, contentType, multipartChunkSize, baseCDN, jsonpCallback, defaultEffects }: FileFromOptions & GroupFromOptions): Promise<UploadcareGroup>;
-declare class UploadClient {
+export function uploadFileGroup(data: (NodeFile | BrowserFile)[] | Url[] | Uuid[], { publicKey, fileName, baseURL, secureSignature, secureExpire, store, signal, onProgress, source, integration, userAgent, retryThrottledRequestMaxTimes, contentType, multipartChunkSize, baseCDN, jsonpCallback }: FileFromOptions & GroupFromOptions): Promise<UploadcareGroup>;
+export declare class UploadClient {
 	private settings;
 	constructor(settings: Settings);
 	updateSettings(newSettings: Settings): void;
@@ -460,21 +486,5 @@ export declare class UploadClientError extends Error {
 	readonly headers?: Headers;
 	constructor(message: string, code?: string, request?: ErrorRequestInfo, response?: ErrorResponseInfo, headers?: Headers);
 }
-export { AbortController } from "abort-controller";
-
-export {
-	UploadClient as UploadClient,
-	base as base,
-	fromUrl as fromUrl,
-	fromUrlStatus as fromUrlStatus,
-	group as group,
-	groupInfo as groupInfo,
-	info as info,
-	multipartComplete as multipartComplete,
-	multipartStart as multipartStart,
-	multipartUpload as multipartUpload,
-	uploadFileGroup as uploadFileGroup,
-	uploadFromObject as uploadBase,
-};
 
 export {};

package/package.json

@@ -1,25 +1,17 @@
 {
   "name": "@uploadcare/upload-client",
-  "version": "3.1.0",
+  "version": "4.0.0",
   "description": "Library for work with Uploadcare Upload API",
   "type": "module",
-  "main": "dist/index.cjs",
-  "module": "dist/index.js",
+  "main": "dist/index.node.js",
+  "module": "dist/index.node.js",
+  "browser": "dist/index.browser.js",
+  "react-native": "dist/index.react-native.js",
   "types": "dist/types.d.ts",
   "sideEffects": false,
   "files": [
     "dist/*"
   ],
-  "browser": {
-    "./dist/index.cjs": "./dist/index.browser.cjs",
-    "./dist/index.js": "./dist/index.browser.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 ./mock-server/server.ts --silent",
@@ -30,7 +22,7 @@
     "test:jest": "jest",
     "prebuild": "npm run clean",
     "build": "npm run build:types && npm run build:compile",
-    "build:types": "dts-bundle-generator -o dist/types.d.ts src/index.ts",
+    "build:types": "dts-bundle-generator --project tsconfig.dts.json -o dist/types.d.ts src/index.ts",
     "build:compile": "rollup -c",
     "release:prepare": "shipjs prepare",
     "release:trigger": "shipjs trigger"
@@ -55,46 +47,47 @@
     "cdn"
   ],
   "devDependencies": {
-    "@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",
+    "@koa/cors": "3.3.0",
+    "@koa/router": "10.1.1",
+    "@rollup/plugin-alias": "^3.1.9",
+    "@rollup/plugin-node-resolve": "^13.3.0",
+    "@rollup/plugin-typescript": "^8.3.2",
+    "@types/express-serve-static-core": "^4.17.28",
     "@types/form-data": "2.5.0",
-    "@types/jest": "26.0.14",
-    "@types/koa": "2.11.4",
-    "@types/node": "12.12.67",
+    "@types/jest": "27.0.0",
+    "@types/koa": "2.13.4",
+    "@types/node": "17.0.38",
     "@types/promise": "7.1.30",
-    "@typescript-eslint/eslint-plugin": "5.3.1",
-    "@typescript-eslint/parser": "5.3.1",
+    "@types/ws": "8.5.3",
+    "@typescript-eslint/eslint-plugin": "5.27.0",
+    "@typescript-eslint/parser": "5.27.0",
     "chalk": "4.1.0",
     "data-uri-to-buffer": "3.0.1",
     "dataurl-to-blob": "0.0.1",
     "dotenv": "8.2.0",
+    "dts-bundle-generator": "6.9.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",
+    "jest": "^28.1.0",
+    "jest-environment-jsdom": "28.1.0",
+    "jest-websocket-mock": "2.3.0",
+    "koa": "2.13.4",
     "koa-add-trailing-slashes": "2.0.1",
-    "koa-body": "4.2.0",
+    "koa-body": "5.0.0",
     "mock-socket": "9.0.3",
+    "prettier": "2.2.1",
     "prettier-config-standard": "4.0.0",
     "rimraf": "3.0.2",
+    "rollup": "^2.75.5",
     "shipjs": "0.24.0",
     "start-server-and-test": "1.11.7",
-    "ts-jest": "26.4.1",
-    "ts-node": "10.5.0"
+    "ts-jest": "28.0.3",
+    "ts-node": "^10.8.0",
+    "tslib": "^2.4.0",
+    "typescript": "^4.7.2"
   },
   "dependencies": {
-    "abort-controller": "^3.0.0",
     "form-data": "^4.0.0",
     "ws": "^8.2.3"
   }