got 11.6.2 → 11.8.2

package/dist/source/as-promise/index.js

@@ -133,9 +133,10 @@ function asPromise(normalizedOptions) {
                 reject(error);
             };
             request.once('error', onError);
+            const previousBody = request.options.body;
             request.once('retry', (newRetryCount, error) => {
-                var _a;
-                if (is_1.default.nodeStream((_a = error.request) === null || _a === void 0 ? void 0 : _a.options.body)) {
+                var _a, _b;
+                if (previousBody === ((_a = error.request) === null || _a === void 0 ? void 0 : _a.options.body) && is_1.default.nodeStream((_b = error.request) === null || _b === void 0 ? void 0 : _b.options.body)) {
                     onError(error);
                     return;
                 }

package/dist/source/as-promise/parse-body.js

@@ -11,7 +11,7 @@ const parseBody = (response, responseType, parseJson, encoding) => {
             return rawBody.length === 0 ? '' : parseJson(rawBody.toString());
         }
         if (responseType === 'buffer') {
-            return Buffer.from(rawBody);
+            return rawBody;
         }
         throw new types_1.ParseError({
             message: `Unknown body type '${responseType}'`,

package/dist/source/core/index.d.ts

@@ -41,12 +41,8 @@ export interface Agents {
 }
 export declare const withoutBody: ReadonlySet<string>;
 export interface ToughCookieJar {
-    getCookieString: ((currentUrl: string, options: {
-        [key: string]: unknown;
-    }, cb: (err: Error | null, cookies: string) => void) => void) & ((url: string, callback: (error: Error | null, cookieHeader: string) => void) => void);
-    setCookie: ((cookieOrString: unknown, currentUrl: string, options: {
-        [key: string]: unknown;
-    }, cb: (err: Error | null, cookie: unknown) => void) => void) & ((rawCookie: string, url: string, callback: (error: Error | null, result: unknown) => void) => void);
+    getCookieString: ((currentUrl: string, options: Record<string, unknown>, cb: (err: Error | null, cookies: string) => void) => void) & ((url: string, callback: (error: Error | null, cookieHeader: string) => void) => void);
+    setCookie: ((cookieOrString: unknown, currentUrl: string, options: Record<string, unknown>, cb: (err: Error | null, cookie: unknown) => void) => void) & ((rawCookie: string, url: string, callback: (error: Error | null, result: unknown) => void) => void);
 }
 export interface PromiseCookieJar {
     getCookieString: (url: string) => Promise<string>;
@@ -352,9 +348,7 @@ interface PlainOptions extends URLOptions {
 
     __Note #2__: This option is not enumerable and will not be merged with the instance defaults.
     */
-    form?: {
-        [key: string]: any;
-    };
+    form?: Record<string, any>;
     /**
     JSON body. If the `Content-Type` header is not set, it will be set to `application/json`.
 
@@ -362,9 +356,7 @@ interface PlainOptions extends URLOptions {
 
     __Note #2__: This option is not enumerable and will not be merged with the instance defaults.
     */
-    json?: {
-        [key: string]: any;
-    };
+    json?: Record<string, any>;
     /**
     The URL to request, as a string, a [`https.request` options object](https://nodejs.org/api/https.html#https_https_request_options_callback), or a [WHATWG `URL`](https://nodejs.org/api/url.html#url_class_url).
 
@@ -415,9 +407,7 @@ interface PlainOptions extends URLOptions {
     //=> 'key=a&key=b'
     ```
     */
-    searchParams?: string | {
-        [key: string]: string | number | boolean | null | undefined;
-    } | URLSearchParams;
+    searchParams?: string | Record<string, string | number | boolean | null | undefined> | URLSearchParams;
     /**
     An instance of [`CacheableLookup`](https://github.com/szmarczak/cacheable-lookup) used for making DNS lookups.
     Useful when making lots of requests to different *public* hostnames.
@@ -738,6 +728,7 @@ export interface HTTPSOptions {
     The passphrase to decrypt the `options.https.key` (if different keys have different passphrases refer to `options.https.key` documentation).
     */
     passphrase?: SecureContextOptions['passphrase'];
+    pfx?: SecureContextOptions['pfx'];
 }
 interface NormalizedPlainOptions extends PlainOptions {
     method: Method;

package/dist/source/core/index.js

@@ -29,7 +29,7 @@ const is_response_ok_1 = require("./utils/is-response-ok");
 const deprecation_warning_1 = require("../utils/deprecation-warning");
 const normalize_arguments_1 = require("../as-promise/normalize-arguments");
 const calculate_retry_delay_1 = require("./calculate-retry-delay");
-const globalDnsCache = new cacheable_lookup_1.default();
+let globalDnsCache;
 const kRequest = Symbol('request');
 const kResponse = Symbol('response');
 const kResponseSize = Symbol('responseSize');
@@ -152,7 +152,7 @@ class RequestError extends Error {
         }
         this.timings = (_a = this.request) === null || _a === void 0 ? void 0 : _a.timings;
         // Recover the original stacktrace
-        if (!is_1.default.undefined(error.stack)) {
+        if (is_1.default.string(error.stack) && is_1.default.string(this.stack)) {
             const indexOfMessage = this.stack.indexOf(this.message) + this.message.length;
             const thisStackTrace = this.stack.slice(indexOfMessage).split('\n').reverse();
             const errorStackTrace = error.stack.slice(error.stack.indexOf(error.message) + error.message.length).split('\n').reverse();
@@ -295,18 +295,28 @@ class Request extends stream_1.Duplex {
         if (json || body || form) {
             this._lockWrite();
         }
-        (async (nonNormalizedOptions) => {
-            var _a;
+        if (exports.kIsNormalizedAlready in options) {
+            this.options = options;
+        }
+        else {
             try {
-                if (nonNormalizedOptions.body instanceof fs_1.ReadStream) {
-                    await waitForOpenFile(nonNormalizedOptions.body);
-                }
-                if (exports.kIsNormalizedAlready in nonNormalizedOptions) {
-                    this.options = nonNormalizedOptions;
+                // @ts-expect-error Common TypeScript bug saying that `this.constructor` is not accessible
+                this.options = this.constructor.normalizeArguments(url, options, defaults);
+            }
+            catch (error) {
+                // TODO: Move this to `_destroy()`
+                if (is_1.default.nodeStream(options.body)) {
+                    options.body.destroy();
                 }
-                else {
-                    // @ts-expect-error Common TypeScript bug saying that `this.constructor` is not accessible
-                    this.options = this.constructor.normalizeArguments(url, nonNormalizedOptions, defaults);
+                this.destroy(error);
+                return;
+            }
+        }
+        (async () => {
+            var _a;
+            try {
+                if (this.options.body instanceof fs_1.ReadStream) {
+                    await waitForOpenFile(this.options.body);
                 }
                 const { url: normalizedURL } = this.options;
                 if (!normalizedURL) {
@@ -338,7 +348,7 @@ class Request extends stream_1.Duplex {
                     this.destroy(error);
                 }
             }
-        })(options);
+        })();
     }
     static normalizeArguments(url, options, defaults) {
         var _a, _b, _c, _d, _e;
@@ -394,6 +404,7 @@ class Request extends stream_1.Duplex {
             is_1.assert.any([is_1.default.string, is_1.default.object, is_1.default.array, is_1.default.undefined], options.https.key);
             is_1.assert.any([is_1.default.string, is_1.default.object, is_1.default.array, is_1.default.undefined], options.https.certificate);
             is_1.assert.any([is_1.default.string, is_1.default.undefined], options.https.passphrase);
+            is_1.assert.any([is_1.default.string, is_1.default.buffer, is_1.default.array, is_1.default.undefined], options.https.pfx);
         }
         is_1.assert.any([is_1.default.object, is_1.default.undefined], options.cacheOptions);
         // `options.method`
@@ -472,6 +483,9 @@ class Request extends stream_1.Duplex {
             options.url = options_to_url_1.default(options.prefixUrl, options);
         }
         if (options.url) {
+            if ('port' in options) {
+                delete options.port;
+            }
             // Make it possible to change `options.prefixUrl`
             let { prefixUrl } = options;
             Object.defineProperty(options, 'prefixUrl', {
@@ -572,6 +586,9 @@ class Request extends stream_1.Duplex {
         options.cacheOptions = { ...options.cacheOptions };
         // `options.dnsCache`
         if (options.dnsCache === true) {
+            if (!globalDnsCache) {
+                globalDnsCache = new cacheable_lookup_1.default();
+            }
             options.dnsCache = globalDnsCache;
         }
         else if (!is_1.default.undefined(options.dnsCache) && !options.dnsCache.lookup) {
@@ -614,7 +631,7 @@ class Request extends stream_1.Duplex {
         if (defaults && !areHooksDefault) {
             for (const event of exports.knownHookEvents) {
                 const defaultHooks = defaults.hooks[event];
-                if (defaultHooks.length !== 0) {
+                if (defaultHooks.length > 0) {
                     // See https://github.com/microsoft/TypeScript/issues/31445#issuecomment-576929044
                     options.hooks[event] = [
                         ...defaults.hooks[event],
@@ -649,6 +666,9 @@ class Request extends stream_1.Duplex {
         if ('passphrase' in options) {
             deprecation_warning_1.default('"options.passphrase" was never documented, please use "options.https.passphrase"');
         }
+        if ('pfx' in options) {
+            deprecation_warning_1.default('"options.pfx" was never documented, please use "options.https.pfx"');
+        }
         // Other options
         if ('followRedirects' in options) {
             throw new TypeError('The `followRedirects` option does not exist. Use `followRedirect` instead.');
@@ -826,6 +846,8 @@ class Request extends stream_1.Duplex {
                 if ('form' in options) {
                     delete options.form;
                 }
+                this[kBody] = undefined;
+                delete options.headers['content-length'];
             }
             if (this.redirects.length >= options.maxRedirects) {
                 this._beforeError(new MaxRedirectsError(this));
@@ -850,16 +872,14 @@ class Request extends stream_1.Duplex {
                         delete options.headers.authorization;
                     }
                     if (options.username || options.password) {
-                        // TODO: Fix this ignore.
-                        // @ts-expect-error
-                        delete options.username;
-                        // @ts-expect-error
-                        delete options.password;
-                    }
-                    if ('port' in options) {
-                        delete options.port;
+                        options.username = '';
+                        options.password = '';
                     }
                 }
+                else {
+                    redirectUrl.username = options.username;
+                    redirectUrl.password = options.password;
+                }
                 this.redirects.push(redirectString);
                 options.url = redirectUrl;
                 for (const hook of options.hooks.beforeRedirect) {
@@ -933,12 +953,7 @@ class Request extends stream_1.Duplex {
             request.destroy();
             // Node.js <= 12.18.2 mistakenly emits the response `end` first.
             (_a = request.res) === null || _a === void 0 ? void 0 : _a.removeAllListeners('end');
-            if (error instanceof timed_out_1.TimeoutError) {
-                error = new TimeoutError(error, this.timings, this);
-            }
-            else {
-                error = new RequestError(error.message, error, this);
-            }
+            error = error instanceof timed_out_1.TimeoutError ? new TimeoutError(error, this.timings, this) : new RequestError(error.message, error, this);
             this._beforeError(error);
         });
         this[kUnproxyEvents] = proxy_events_1.default(request, this, proxiedRequestEvents);
@@ -1026,6 +1041,9 @@ class Request extends stream_1.Duplex {
                 break;
             }
         }
+        if (options.body && this[kBody] !== options.body) {
+            this[kBody] = options.body;
+        }
         const { agent, request, timeout, url } = options;
         if (options.dnsCache && !('lookup' in options)) {
             options.lookup = options.dnsCache.lookup;
@@ -1098,6 +1116,9 @@ class Request extends stream_1.Duplex {
             if (options.https.passphrase) {
                 requestOptions.passphrase = options.https.passphrase;
             }
+            if (options.https.pfx) {
+                requestOptions.pfx = options.https.pfx;
+            }
         }
         try {
             let requestOrResponse = await fn(url, requestOptions);
@@ -1129,6 +1150,9 @@ class Request extends stream_1.Duplex {
                 if (options.https.passphrase) {
                     delete requestOptions.passphrase;
                 }
+                if (options.https.pfx) {
+                    delete requestOptions.pfx;
+                }
             }
             if (isClientRequest(requestOrResponse)) {
                 this._onRequest(requestOrResponse);
@@ -1293,7 +1317,7 @@ class Request extends stream_1.Duplex {
         });
         // TODO: What happens if it's from cache? Then this[kRequest] won't be defined.
         this[kRequest].write(chunk, encoding, (error) => {
-            if (!error && this._progressCallbacks.length !== 0) {
+            if (!error && this._progressCallbacks.length > 0) {
                 this._progressCallbacks.shift()();
             }
             callback(error);
@@ -1357,7 +1381,7 @@ class Request extends stream_1.Duplex {
     */
     get ip() {
         var _a;
-        return (_a = this[kRequest]) === null || _a === void 0 ? void 0 : _a.socket.remoteAddress;
+        return (_a = this.socket) === null || _a === void 0 ? void 0 : _a.remoteAddress;
     }
     /**
     Indicates whether the request has been aborted or not.
@@ -1367,8 +1391,8 @@ class Request extends stream_1.Duplex {
         return ((_b = (_a = this[kRequest]) === null || _a === void 0 ? void 0 : _a.destroyed) !== null && _b !== void 0 ? _b : this.destroyed) && !((_c = this[kOriginalResponse]) === null || _c === void 0 ? void 0 : _c.complete);
     }
     get socket() {
-        var _a;
-        return (_a = this[kRequest]) === null || _a === void 0 ? void 0 : _a.socket;
+        var _a, _b;
+        return (_b = (_a = this[kRequest]) === null || _a === void 0 ? void 0 : _a.socket) !== null && _b !== void 0 ? _b : undefined;
     }
     /**
     Progress event for downloading (receiving a response).

package/dist/source/core/utils/get-body-size.js

@@ -23,6 +23,9 @@ exports.default = async (body, headers) => {
     }
     if (body instanceof fs_1.ReadStream) {
         const { size } = await statAsync(body.path);
+        if (size === 0) {
+            return undefined;
+        }
         return size;
     }
     return undefined;

package/dist/source/core/utils/url-to-options.js

@@ -14,7 +14,7 @@ exports.default = (url) => {
         href: url.href,
         path: `${url.pathname || ''}${url.search || ''}`
     };
-    if (is_1.default.string(url.port) && url.port.length !== 0) {
+    if (is_1.default.string(url.port) && url.port.length > 0) {
         options.port = Number(url.port);
     }
     if (url.username || url.password) {

package/dist/source/create.js

@@ -82,7 +82,7 @@ const create = (defaults) => {
         return result;
     }));
     // Got interface
-    const got = ((url, options, _defaults) => {
+    const got = ((url, options = {}, _defaults) => {
         var _a, _b;
         let iteration = 0;
         const iterateHandlers = (newOptions) => {
@@ -103,7 +103,7 @@ const create = (defaults) => {
             let initHookError;
             try {
                 callInitHooks(defaults.options.hooks.init, options);
-                callInitHooks((_a = options === null || options === void 0 ? void 0 : options.hooks) === null || _a === void 0 ? void 0 : _a.init, options);
+                callInitHooks((_a = options.hooks) === null || _a === void 0 ? void 0 : _a.init, options);
             }
             catch (error) {
                 initHookError = error;
@@ -117,11 +117,11 @@ const create = (defaults) => {
             return iterateHandlers(normalizedOptions);
         }
         catch (error) {
-            if (options === null || options === void 0 ? void 0 : options.isStream) {
+            if (options.isStream) {
                 throw error;
             }
             else {
-                return create_rejection_1.default(error, defaults.options.hooks.beforeError, (_b = options === null || options === void 0 ? void 0 : options.hooks) === null || _b === void 0 ? void 0 : _b.beforeError);
+                return create_rejection_1.default(error, defaults.options.hooks.beforeError, (_b = options.hooks) === null || _b === void 0 ? void 0 : _b.beforeError);
             }
         }
     });

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "got",
-	"version": "11.6.2",
+	"version": "11.8.2",
 	"description": "Human-friendly and powerful HTTP request library for Node.js",
 	"license": "MIT",
 	"repository": "sindresorhus/got",
@@ -43,7 +43,7 @@
 		"ky"
 	],
 	"dependencies": {
-		"@sindresorhus/is": "^3.1.1",
+		"@sindresorhus/is": "^4.0.0",
 		"@szmarczak/http-timer": "^4.0.5",
 		"@types/cacheable-request": "^6.0.1",
 		"@types/responselike": "^1.0.0",
@@ -61,7 +61,7 @@
 		"@sinonjs/fake-timers": "^6.0.1",
 		"@types/benchmark": "^1.0.33",
 		"@types/express": "^4.17.7",
-		"@types/node": "^14.6.0",
+		"@types/node": "^14.14.0",
 		"@types/node-fetch": "^2.5.7",
 		"@types/pem": "^1.9.5",
 		"@types/pify": "^3.0.2",
@@ -87,11 +87,11 @@
 		"pify": "^5.0.0",
 		"sinon": "^9.0.3",
 		"slow-stream": "0.0.4",
-		"tempy": "^0.6.0",
+		"tempy": "^1.0.0",
 		"to-readable-stream": "^2.1.0",
 		"tough-cookie": "^4.0.0",
-		"typescript": "^4.0.2",
-		"xo": "^0.33.0"
+		"typescript": "4.0.3",
+		"xo": "^0.34.1"
 	},
 	"types": "dist/source",
 	"sideEffects": false,
@@ -123,7 +123,7 @@
 			"node/prefer-global/url": "off",
 			"node/prefer-global/url-search-params": "off",
 			"import/no-anonymous-default-export": "off",
-			"@typescript-eslint/no-invalid-void-type": "off"
+			"@typescript-eslint/no-implicit-any-catch": "off"
 		}
 	},
 	"runkitExampleFilename": "./documentation/examples/runkit-example.js"

package/readme.md

@@ -107,16 +107,16 @@ const got = require('got');
 const pipeline = promisify(stream.pipeline);
 
 (async () => {
-    await pipeline(
-        got.stream('https://sindresorhus.com'),
-        fs.createWriteStream('index.html')
-    );
-
-    // For POST, PUT, and PATCH methods `got.stream` returns a `stream.Writable`
-    await pipeline(
-        fs.createReadStream('index.html'),
-        got.stream.post('https://sindresorhus.com')
-    );
+	await pipeline(
+		got.stream('https://sindresorhus.com'),
+		fs.createWriteStream('index.html')
+	);
+
+	// For POST, PUT, PATCH, and DELETE methods, `got.stream` returns a `stream.Writable`.
+	await pipeline(
+		fs.createReadStream('index.html'),
+		got.stream.post('https://sindresorhus.com')
+	);
 })();
 ```
 
@@ -146,7 +146,7 @@ If no protocol is specified, it will throw a `TypeError`.
 
 **Note:** The query string is **not** parsed as search params. Example:
 
-```
+```js
 got('https://example.com/?query=a b'); //=> https://example.com/?query=a%20b
 got('https://example.com/', {searchParams: {query: 'a b'}}); //=> https://example.com/?query=a+b
 
@@ -306,7 +306,7 @@ Example:
 	const bufferPromise = responsePromise.buffer();
 	const jsonPromise = responsePromise.json();
 
-	const [response, buffer, json] = Promise.all([responsePromise, bufferPromise, jsonPromise]);
+	const [response, buffer, json] = await Promise.all([responsePromise, bufferPromise, jsonPromise]);
 	// `response` is an instance of Got Response
 	// `buffer` is an instance of Buffer
 	// `json` is an object
@@ -321,6 +321,8 @@ const body = await got(url).json();
 const body = await got(url, {responseType: 'json', resolveBodyOnly: true});
 ```
 
+**Note:** `buffer` will return the raw body buffer. Modifying it will also alter the result of `promise.text()` and `promise.json()`. Before overwritting the buffer, please copy it first via `Buffer.from(buffer)`. See https://github.com/nodejs/node/issues/27080
+
 ###### parseJson
 
 Type: `(text: string) => unknown`\
@@ -653,6 +655,15 @@ await got('https://api6.ipify.org', {
 });
 ```
 
+###### lookup
+
+Type: `Function`\
+Default: [`dns.lookup`](https://nodejs.org/api/dns.html#dns_dns_lookup_hostname_options_callback)
+
+Custom DNS resolution logic.
+
+The function signature is the same as [`dns.lookup`](https://nodejs.org/api/dns.html#dns_dns_lookup_hostname_options_callback).
+
 ###### request
 
 Type: `Function`\
@@ -738,6 +749,24 @@ Default: `[]`
 
 Called with [normalized](source/core/index.ts) [request options](#options). Got will make no further changes to the request before it is sent. This is especially useful in conjunction with [`got.extend()`](#instances) when you want to create an API client that, for example, uses HMAC-signing.
 
+**Note:** Changing `options.json` or `options.form` has no effect on the request, you should change `options.body` instead. If needed, update the `options.headers` accordingly. Example:
+
+```js
+const got = require('got');
+
+got.post({
+	json: {payload: 'old'},
+	hooks: {
+		beforeRequest: [
+			options => {
+				options.body = JSON.stringify({payload: 'new'});
+				options.headers['content-length'] = options.body.length.toString();
+			}
+		]
+	}
+});
+```
+
 **Tip:** You can override the `request` function by returning a [`ClientRequest`-like](https://nodejs.org/api/http.html#http_class_http_clientrequest) instance or a [`IncomingMessage`-like](https://nodejs.org/api/http.html#http_class_http_incomingmessage) instance. This is very useful when creating a custom cache mechanism.
 
 ###### hooks.beforeRedirect
@@ -853,12 +882,12 @@ got('https://api.github.com/some-endpoint', {
 		beforeError: [
 			error => {
 				const {response} = error;
- 				if (response && response.body) {
+				if (response && response.body) {
 					error.name = 'GitHubError';
 					error.message = `${response.body.message} (${response.statusCode})`;
 				}
 
- 				return error;
+				return error;
 			}
 		]
 	}
@@ -1022,7 +1051,24 @@ Type: `string`
 
 The passphrase to decrypt the `options.https.key` (if different keys have different passphrases refer to `options.https.key` documentation).
 
-##### Examples for `https.key`, `https.certificate` and `https.passphrase`
+##### https.pfx
+
+Type: `string | Buffer | Array<string | Buffer | object>`
+
+[PFX or PKCS12](https://en.wikipedia.org/wiki/PKCS_12) encoded private key and certificate chain. Using `options.https.pfx` is an alternative to providing `options.https.key` and `options.https.certificate` individually. A PFX is usually encrypted, and if it is, `options.https.passphrase` will be used to decrypt it.
+
+Multiple PFX's can be be provided as an array of unencrypted buffers or an array of objects like:
+
+```ts
+{
+	buffer: string | Buffer,
+	passphrase?: string
+}
+```
+
+This object form can only occur in an array. If the provided buffers are encrypted, `object.passphrase` can be used to decrypt them. If `object.passphrase` is not provided, `options.https.passphrase` will be used for decryption.
+
+##### Examples for `https.key`, `https.certificate`, `https.passphrase`, and `https.pfx`
 
 ```js
 // Single key with certificate
@@ -1069,6 +1115,45 @@ got('https://example.com', {
 		]
 	}
 });
+
+// Single encrypted PFX with passphrase
+got('https://example.com', {
+	https: {
+		pfx: fs.readFileSync('./fake.pfx'),
+		passphrase: 'passphrase'
+	}
+});
+
+// Multiple encrypted PFX's with different passphrases
+got('https://example.com', {
+	https: {
+		pfx: [
+			{
+				buffer: fs.readFileSync('./key1.pfx'),
+				passphrase: 'passphrase1'
+			},
+			{
+				buffer: fs.readFileSync('./key2.pfx'),
+				passphrase: 'passphrase2'
+			}
+		]
+	}
+});
+
+// Multiple encrypted PFX's with single passphrase
+got('https://example.com', {
+	https: {
+		passphrase: 'passphrase',
+		pfx: [
+			{
+				buffer: fs.readFileSync('./key1.pfx')
+			},
+			{
+				buffer: fs.readFileSync('./key2.pfx')
+			}
+		]
+	}
+});
 ```
 
 ##### https.rejectUnauthorized