got 12.6.0 → 13.0.0

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

@@ -4,7 +4,6 @@
 /// <reference types="node" resolution-mode="require"/>
 /// <reference types="node" resolution-mode="require"/>
 import { Duplex } from 'node:stream';
-import { URL } from 'node:url';
 import type { ClientRequest } from 'node:http';
 import type { Socket } from 'node:net';
 import type { Timings } from '@szmarczak/http-timer';
@@ -107,7 +106,7 @@ export default class Request extends Duplex implements RequestEvents<Request> {
     private _isFromCache?;
     private _cannotHaveBody;
     private _triggerRead;
-    private _jobs;
+    private readonly _jobs;
     private _cancelTimeouts;
     private readonly _removeListeners;
     private _nativeResponse?;

package/dist/source/core/index.js

@@ -1,13 +1,12 @@
 import process from 'node:process';
 import { Buffer } from 'node:buffer';
 import { Duplex } from 'node:stream';
-import { URL, URLSearchParams } from 'node:url';
 import http, { ServerResponse } from 'node:http';
 import timer from '@szmarczak/http-timer';
 import CacheableRequest, { CacheError as CacheableCacheError, } from 'cacheable-request';
 import decompressResponse from 'decompress-response';
 import is from '@sindresorhus/is';
-import { buffer as getBuffer } from 'get-stream';
+import getStream from 'get-stream';
 import { FormDataEncoder, isFormData as isFormDataLike } from 'form-data-encoder';
 import getBodySize from './utils/get-body-size.js';
 import isFormData from './utils/is-form-data.js';
@@ -21,6 +20,7 @@ import { isResponseOk } from './response.js';
 import isClientRequest from './utils/is-client-request.js';
 import isUnixSocketURL from './utils/is-unix-socket-url.js';
 import { RequestError, ReadError, MaxRedirectsError, HTTPError, TimeoutError, UploadError, CacheError, AbortError, } from './errors.js';
+const { buffer: getStreamAsBuffer } = getStream;
 const supportsBrotli = is.string(process.versions.brotli);
 const methodsWithoutBody = new Set(['GET', 'HEAD']);
 const cacheableStore = new WeakableMap();
@@ -210,8 +210,8 @@ export default class Request extends Duplex {
         this.redirectUrls = [];
         this.retryCount = 0;
         this._stopRetry = noop;
-        this.on('pipe', source => {
-            if (source.headers) {
+        this.on('pipe', (source) => {
+            if (source?.headers) {
                 Object.assign(this.options.headers, source.headers);
             }
         });
@@ -267,7 +267,7 @@ export default class Request extends Duplex {
             else {
                 this.options.signal.addEventListener('abort', abort);
                 this._removeListeners = () => {
-                    this.options.signal.removeEventListener('abort', abort);
+                    this.options.signal?.removeEventListener('abort', abort);
                 };
             }
         }
@@ -749,7 +749,10 @@ export default class Request extends Duplex {
         }
         try {
             // Errors are emitted via the `error` event
-            const rawBody = await getBuffer(from);
+            const rawBody = await getStreamAsBuffer(from);
+            // TODO: Switch to this:
+            // let rawBody = await from.toArray();
+            // rawBody = Buffer.concat(rawBody);
             // On retry Request is destroyed with no error, therefore the above will successfully resolve.
             // So in order to check if this was really successfull, we need to check if it has been properly ended.
             if (!this.isAborted) {
@@ -843,7 +846,6 @@ export default class Request extends Duplex {
                     // We only need to implement the error handler in order to support HTTP2 caching.
                     // The result will be a promise anyway.
                     // @ts-expect-error ignore
-                    // eslint-disable-next-line @typescript-eslint/promise-function-async
                     result.once = (event, handler) => {
                         if (event === 'error') {
                             (async () => {

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

@@ -8,7 +8,6 @@
 /// <reference types="node" resolution-mode="require"/>
 /// <reference types="node" resolution-mode="require"/>
 import type { Buffer } from 'node:buffer';
-import { URL, URLSearchParams } from 'node:url';
 import { checkServerIdentity } from 'node:tls';
 import http from 'node:http';
 import https from 'node:https';
@@ -567,7 +566,7 @@ export type OptionsInit = Except<Partial<InternalsType>, 'hooks' | 'retry'> & {
 };
 export default class Options {
     private _unixOptions?;
-    private _internals;
+    private readonly _internals;
     private _merging;
     private readonly _init;
     constructor(input?: string | URL | OptionsInit, options?: OptionsInit, defaults?: Options);
@@ -741,8 +740,6 @@ export default class Options {
     /**
     You can abort the `request` using [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
 
-    *Requires Node.js 16 or later.*
-
     @example
     ```
     import got from 'got';
@@ -758,8 +755,8 @@ export default class Options {
     }, 100);
     ```
     */
-    get signal(): any | undefined;
-    set signal(value: any | undefined);
+    get signal(): AbortSignal | undefined;
+    set signal(value: AbortSignal | undefined);
     /**
     Ignore invalid cookies instead of throwing an error.
     Only useful when the `cookieJar` option has been set. Not recommended.
@@ -1147,7 +1144,7 @@ export default class Options {
         form: Record<string, any> | undefined;
         url: string | URL | undefined;
         cookieJar: PromiseCookieJar | ToughCookieJar | undefined;
-        signal: any;
+        signal: AbortSignal | undefined;
         ignoreInvalidCookies: boolean;
         searchParams: string | SearchParameters | URLSearchParams | undefined;
         dnsLookup: {
@@ -1235,6 +1232,7 @@ export default class Options {
         signal?: AbortSignal | undefined;
         socketPath?: string | undefined;
         uniqueHeaders?: (string | string[])[] | undefined;
+        joinDuplicateHeaders?: boolean | undefined;
         clientCertEngine?: string | undefined;
         privateKeyEngine?: string | undefined;
         privateKeyIdentifier?: string | undefined;

package/dist/source/core/options.js

@@ -1,6 +1,5 @@
 import process from 'node:process';
 import { promisify, inspect } from 'node:util';
-import { URL, URLSearchParams } from 'node:url';
 import { checkServerIdentity } from 'node:tls';
 // DO NOT use destructuring for `https.request` and `http.request` as it's not compatible with `nock`.
 import http from 'node:http';
@@ -181,7 +180,7 @@ const defaultInternals = {
     setHost: true,
     maxHeaderSize: undefined,
     signal: undefined,
-    enableUnixSockets: true,
+    enableUnixSockets: false,
 };
 const cloneInternals = (internals) => {
     const { hooks, retry } = internals;
@@ -408,7 +407,12 @@ export default class Options {
                     throw new Error(`Unexpected option: ${key}`);
                 }
                 // @ts-expect-error Type 'unknown' is not assignable to type 'never'.
-                this[key] = options[key];
+                const value = options[key];
+                if (value === undefined) {
+                    continue;
+                }
+                // @ts-expect-error Type 'unknown' is not assignable to type 'never'.
+                this[key] = value;
                 push = true;
             }
             if (push) {
@@ -764,8 +768,6 @@ export default class Options {
     /**
     You can abort the `request` using [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
 
-    *Requires Node.js 16 or later.*
-
     @example
     ```
     import got from 'got';
@@ -781,11 +783,9 @@ export default class Options {
     }, 100);
     ```
     */
-    // TODO: Replace `any` with `AbortSignal` when targeting Node 16.
     get signal() {
         return this._internals.signal;
     }
-    // TODO: Replace `any` with `AbortSignal` when targeting Node 16.
     set signal(value) {
         assert.object(value);
         this._internals.signal = value;

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

@@ -1,7 +1,6 @@
 /// <reference types="node" resolution-mode="require"/>
 /// <reference types="node" resolution-mode="require"/>
 import type { Buffer } from 'node:buffer';
-import type { URL } from 'node:url';
 import type { IncomingMessageWithTimings, Timings } from '@szmarczak/http-timer';
 import { RequestError } from './errors.js';
 import type { ParseJsonFunction, ResponseType } from './options.js';

package/dist/source/core/timed-out.js

@@ -55,13 +55,13 @@ export default function timedOut(request, delays, options) {
             throw error;
         }
     });
-    if (typeof delays.request !== 'undefined') {
+    if (delays.request !== undefined) {
         const cancelTimeout = addTimeout(delays.request, timeoutHandler, 'request');
         once(request, 'response', (response) => {
             once(response, 'end', cancelTimeout);
         });
     }
-    if (typeof delays.socket !== 'undefined') {
+    if (delays.socket !== undefined) {
         const { socket } = delays;
         const socketTimeoutHandler = () => {
             timeoutHandler(socket, 'socket');
@@ -74,17 +74,17 @@ export default function timedOut(request, delays, options) {
             request.removeListener('timeout', socketTimeoutHandler);
         });
     }
-    const hasLookup = typeof delays.lookup !== 'undefined';
-    const hasConnect = typeof delays.connect !== 'undefined';
-    const hasSecureConnect = typeof delays.secureConnect !== 'undefined';
-    const hasSend = typeof delays.send !== 'undefined';
+    const hasLookup = delays.lookup !== undefined;
+    const hasConnect = delays.connect !== undefined;
+    const hasSecureConnect = delays.secureConnect !== undefined;
+    const hasSend = delays.send !== undefined;
     if (hasLookup || hasConnect || hasSecureConnect || hasSend) {
         once(request, 'socket', (socket) => {
             const { socketPath } = request;
             /* istanbul ignore next: hard to test */
             if (socket.connecting) {
                 const hasPath = Boolean(socketPath ?? net.isIP(hostname ?? host ?? '') !== 0);
-                if (hasLookup && !hasPath && typeof socket.address().address === 'undefined') {
+                if (hasLookup && !hasPath && socket.address().address === undefined) {
                     const cancelTimeout = addTimeout(delays.lookup, timeoutHandler, 'lookup');
                     once(socket, 'lookup', cancelTimeout);
                 }
@@ -122,13 +122,13 @@ export default function timedOut(request, delays, options) {
             }
         });
     }
-    if (typeof delays.response !== 'undefined') {
+    if (delays.response !== undefined) {
         once(request, 'upload-complete', () => {
             const cancelTimeout = addTimeout(delays.response, timeoutHandler, 'response');
             once(request, 'response', cancelTimeout);
         });
     }
-    if (typeof delays.read !== 'undefined') {
+    if (delays.read !== undefined) {
         once(request, 'response', (response) => {
             const cancelTimeout = addTimeout(delays.read, timeoutHandler, 'read');
             once(response, 'end', cancelTimeout);

package/dist/source/core/utils/is-unix-socket-url.d.ts

@@ -1,3 +1,2 @@
 /// <reference types="node" resolution-mode="require"/>
-import type { URL } from 'url';
 export default function isUnixSocketURL(url: URL): boolean;

package/dist/source/core/utils/options-to-url.d.ts

@@ -1,5 +1,4 @@
 /// <reference types="node" resolution-mode="require"/>
-import { URL } from 'node:url';
 export type URLOptions = {
     href?: string;
     protocol?: string;

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

@@ -1,5 +1,3 @@
-/* istanbul ignore file: deprecated */
-import { URL } from 'node:url';
 const keys = [
     'protocol',
     'host',

package/dist/source/core/utils/url-to-options.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" resolution-mode="require"/>
-import type { URL, UrlWithStringQuery } from 'node:url';
+import type { UrlWithStringQuery } from 'node:url';
 export type LegacyUrlOptions = {
     protocol: string;
     hostname: string;

package/dist/source/types.d.ts

@@ -1,7 +1,6 @@
 /// <reference types="node" resolution-mode="require"/>
 /// <reference types="node" resolution-mode="require"/>
 import type { Buffer } from 'node:buffer';
-import type { URL } from 'node:url';
 import type { CancelableRequest } from './as-promise/types.js';
 import type { Response } from './core/response.js';
 import type Options from './core/options.js';

package/package.json

@@ -1,15 +1,17 @@
 {
 	"name": "got",
-	"version": "12.6.0",
+	"version": "13.0.0",
 	"description": "Human-friendly and powerful HTTP request library for Node.js",
 	"license": "MIT",
 	"repository": "sindresorhus/got",
 	"funding": "https://github.com/sindresorhus/got?sponsor=1",
 	"type": "module",
-	"exports": "./dist/source/index.js",
-	"types": "./dist/source/index.d.ts",
+	"exports": {
+		"types": "./dist/source/index.d.ts",
+		"default": "./dist/source/index.js"
+	},
 	"engines": {
-		"node": ">=14.16"
+		"node": ">=16"
 	},
 	"scripts": {
 		"test": "xo && tsc --noEmit && ava",
@@ -99,8 +101,8 @@
 		"tough-cookie": "4.1.2",
 		"ts-node": "^10.8.2",
 		"type-fest": "^3.6.1",
-		"typescript": "~4.9.5",
-		"xo": "^0.53.1"
+		"typescript": "^5.0.4",
+		"xo": "^0.54.2"
 	},
 	"sideEffects": false,
 	"ava": {
@@ -135,10 +137,7 @@
 		"rules": {
 			"@typescript-eslint/no-empty-function": "off",
 			"n/no-deprecated-api": "off",
-			"n/prefer-global/url": "off",
-			"n/prefer-global/url-search-params": "off",
 			"@typescript-eslint/no-implicit-any-catch": "off",
-			"unicorn/prefer-node-protocol": "off",
 			"ava/assertion-arguments": "off",
 			"@typescript-eslint/no-unsafe-member-access": "off",
 			"@typescript-eslint/no-unsafe-return": "off",
@@ -146,6 +145,8 @@
 			"@typescript-eslint/no-unsafe-call": "off",
 			"@typescript-eslint/await-thenable": "off",
 			"@typescript-eslint/no-redundant-type-constituents": "off",
+			"@typescript-eslint/no-unsafe-argument": "off",
+			"@typescript-eslint/promise-function-async": "off",
 			"no-lone-blocks": "off",
 			"unicorn/no-await-expression-member": "off"
 		}

package/readme.md

@@ -29,38 +29,42 @@
 		<br>
 		<br>
 		<br>
-		<a href="https://www.useanvil.com/?utm_source=sindresorhus#gh-light-mode-only">
+		<a href="https://serpapi.com#gh-light-mode-only">
 			<div>
-				<img src="https://sindresorhus.com/assets/thanks/anvil-logo-light.svg" width="200" alt="Anvil">
+				<img src="https://sindresorhus.com/assets/thanks/serpapi-logo-light.svg" width="130" alt="SerpApi">
 			</div>
-			<br>
-			<b>Paperwork that makes the data work.</b>
+			<b>API to get search engine results with ease.</b>
+		</a>
+		<a href="https://serpapi.com#gh-dark-mode-only">
 			<div>
-				<sub>
-				Easy APIs for paperwork. PDF generation, e-signature and embeddable no-code webforms.
-				<br>
-				The easiest way to build paperwork automation into your product.
-				</sub>
+				<img src="https://sindresorhus.com/assets/thanks/serpapi-logo-dark.svg" width="120" alt="SerpApi">
 			</div>
+			<b>API to get search engine results with ease.</b>
 		</a>
-		<a href="https://www.useanvil.com/?utm_source=sindresorhus#gh-dark-mode-only">
+		<br>
+		<br>
+		<br>
+		<br>
+		<a href="https://dutchis.net/?ref=sindresorhus#gh-light-mode-only">
 			<div>
-				<img src="https://sindresorhus.com/assets/thanks/anvil-logo-dark.svg" width="200" alt="Anvil">
+				<img src="https://sindresorhus.com/assets/thanks/dutchis-logo-light.png" width="200" alt="DutchIS">
 			</div>
 			<br>
-			<b>Paperwork that makes the data work.</b>
+			<b>VPS hosting with taste 😛</b>
+		</a>
+		<a href="https://dutchis.net/?ref=sindresorhus#gh-dark-mode-only">
 			<div>
-				<sub>
-				Easy APIs for paperwork. PDF generation, e-signature and embeddable no-code webforms.
-				<br>
-				The easiest way to build paperwork automation into your product.
-				</sub>
+				<img src="https://sindresorhus.com/assets/thanks/dutchis-logo-dark.png" width="200" alt="DutchIS">
 			</div>
+			<br>
+			<b>VPS hosting with taste 😛</b>
 		</a>
 		<br>
 		<br>
 		<br>
 		<br>
+		<br>
+		<br>
 	</p>
 	<br>
 	<br>
@@ -90,7 +94,7 @@ npm install got
 
 **Warning:** This package is native [ESM](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules) and no longer provides a CommonJS export. If your project uses CommonJS, you will have to [convert to ESM](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c) or use the [dynamic `import()`](https://v8.dev/features/dynamic-import) function. Please don't open issues for questions regarding CommonJS / ESM.
 
-**Got v11 (the previous major version) is no longer maintained and we will not accept any backport requests.**
+**Got v11 is no longer maintained and we will not accept any backport requests.**
 
 ## Take a peek
 
@@ -199,7 +203,7 @@ By default, Got will retry on failure. To disable this option, set [`options.ret
 | Pagination API        | :heavy_check_mark:  | :x:                  | :x:                      | :x:                | :x:                    |
 | Request cancelation   | :heavy_check_mark:  | :heavy_check_mark:   | :heavy_check_mark:       | :heavy_check_mark: | :heavy_check_mark:     |
 | RFC compliant caching | :heavy_check_mark:  | :x:                  | :x:                      | :x:                | :x:                    |
-| Cookies (out-of-box)  | :heavy_check_mark:  | :x:                  | :x:                      | :x:                | :x:                    |
+| Cookies (out-of-the-box)  | :heavy_check_mark:  | :x:                  | :x:                      | :x:                | :x:                    |
 | Follows redirects     | :heavy_check_mark:  | :heavy_check_mark:   | :heavy_check_mark:       | :heavy_check_mark: | :heavy_check_mark:     |
 | Retries on failure    | :heavy_check_mark:  | :x:                  | :heavy_check_mark:       | :x:                | :heavy_check_mark:     |
 | Progress events       | :heavy_check_mark:  | :x:                  | :heavy_check_mark:\*\*\* | Browser only       | :heavy_check_mark:     |
@@ -305,13 +309,13 @@ By default, Got will retry on failure. To disable this option, set [`options.ret
 [gbg]: https://img.shields.io/github/issues-raw/sindresorhus/got/bug?color=darkred&label
 [kbg]: https://img.shields.io/github/issues-raw/sindresorhus/ky/bug?color=darkred&label
 [nbg]: https://img.shields.io/github/issues-raw/bitinn/node-fetch/bug?color=darkred&label
-[abg]: https://img.shields.io/github/issues-raw/axios/axios/type:confirmed%20bug?color=darkred&label
+[abg]: https://img.shields.io/github/issues-raw/axios/axios/bug-fix?color=darkred&label
 [sbg]: https://img.shields.io/github/issues-raw/visionmedia/superagent/Bug?color=darkred&label
 
 [g6]: https://github.com/sindresorhus/got/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Abug
 [k6]: https://github.com/sindresorhus/ky/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Abug
 [n6]: https://github.com/bitinn/node-fetch/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Abug
-[a6]: https://github.com/axios/axios/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22type%3Aconfirmed+bug%22
+[a6]: https://github.com/axios/axios/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22bug-fix%22
 [s6]: https://github.com/visionmedia/superagent/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3ABug
 
 <!-- DEPENDENTS -->
@@ -432,7 +436,7 @@ By default, Got will retry on failure. To disable this option, set [`options.ret
 		</td>
 		<td align="center">
 			<a href="https://github.com/renovatebot/renovate">
-				<img width="150" valign="middle" src="https://camo.githubusercontent.com/206d470ac709b9a702a97b0c08d6f389a086793d/68747470733a2f2f72656e6f76617465626f742e636f6d2f696d616765732f6c6f676f2e737667">
+				<img width="150" valign="middle" src="https://camo.githubusercontent.com/7c2dc41a8407d4cfa700f762a1abf46b232858ae7e3a2bf5aee7d9f36416127c/68747470733a2f2f6170702e72656e6f76617465626f742e636f6d2f696d616765732f72656e6f766174655f3636305f3232302e6a7067">
 			</a>
 		</td>
 		<td align="center">