got 12.1.0 → 12.3.1

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

@@ -128,6 +128,10 @@ export default function asPromise(firstRequest) {
         emitter.on(event, fn);
         return promise;
     };
+    promise.off = (event, fn) => {
+        emitter.off(event, fn);
+        return promise;
+    };
     const shortcut = (responseType) => {
         const newPromise = (async () => {
             // Wait until downloading has ended

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

@@ -81,4 +81,10 @@ An error which always triggers a new retry when thrown.
 export declare class RetryError extends RequestError {
     constructor(request: Request);
 }
+/**
+An error to be thrown when the request is aborted by AbortController.
+*/
+export declare class AbortError extends RequestError {
+    constructor(request: Request);
+}
 export {};

package/dist/source/core/errors.js

@@ -166,3 +166,13 @@ export class RetryError extends RequestError {
         this.code = 'ERR_RETRYING';
     }
 }
+/**
+An error to be thrown when the request is aborted by AbortController.
+*/
+export class AbortError extends RequestError {
+    constructor(request) {
+        super('This operation was aborted.', {}, request);
+        this.code = 'ERR_ABORTED';
+        this.name = 'AbortError';
+    }
+}

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

@@ -1,4 +1,9 @@
 /// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
 import { Duplex } from 'node:stream';
 import { URL } from 'node:url';
 import { ServerResponse } from 'node:http';
@@ -26,6 +31,8 @@ export declare type GotEventFunction<T> =
 
 @example
 ```
+import got from 'got';
+
 got.stream('https://github.com')
     .on('request', request => setTimeout(() => request.destroy(), 50));
 ```
@@ -55,6 +62,8 @@ If the `content-length` header is missing, `total` will be `undefined`.
 
 @example
 ```
+import got from 'got';
+
 const response = await got('https://sindresorhus.com')
     .on('downloadProgress', progress => {
         // Report download progress
@@ -78,6 +87,7 @@ See `got.options.retry` for more information.
 export interface RequestEvents<T> {
     on: GotEventFunction<T>;
     once: GotEventFunction<T>;
+    off: GotEventFunction<T>;
 }
 export declare type CacheableRequestFunction = (options: string | URL | NativeRequestOptions, cb?: (response: ServerResponse | ResponseLike) => void) => CacheableRequest.Emitter;
 declare type UrlType = ConstructorParameters<typeof Options>[0];

package/dist/source/core/index.js

@@ -8,7 +8,7 @@ import CacheableRequest from 'cacheable-request';
 import decompressResponse from 'decompress-response';
 import is from '@sindresorhus/is';
 import { buffer as getBuffer } from 'get-stream';
-import { FormDataEncoder, isFormDataLike } from 'form-data-encoder';
+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';
 import proxyEvents from './utils/proxy-events.js';
@@ -20,7 +20,7 @@ import Options from './options.js';
 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, } from './errors.js';
+import { RequestError, ReadError, MaxRedirectsError, HTTPError, TimeoutError, UploadError, CacheError, AbortError, } from './errors.js';
 const supportsBrotli = is.string(process.versions.brotli);
 const methodsWithoutBody = new Set(['GET', 'HEAD']);
 const cacheableStore = new WeakableMap();
@@ -41,6 +41,7 @@ export default class Request extends Duplex {
             // It needs to be zero because we're just proxying the data to another stream
             highWaterMark: 0,
         });
+        // @ts-expect-error - Ignoring for now.
         Object.defineProperty(this, 'constructor', {
             enumerable: true,
             configurable: true,
@@ -233,6 +234,12 @@ export default class Request extends Duplex {
             };
             return;
         }
+        if (this.options.signal?.aborted) {
+            this.destroy(new AbortError(this));
+        }
+        this.options.signal?.addEventListener('abort', () => {
+            this.destroy(new AbortError(this));
+        });
         // Important! If you replace `body` in a handler with another stream, make sure it's readable first.
         // The below is run only once.
         const { body } = this.options;

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

@@ -1,4 +1,12 @@
 /// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
 import { Buffer } from 'node:buffer';
 import { URL, URLSearchParams } from 'node:url';
 import { checkServerIdentity } from 'node:tls';
@@ -731,6 +739,28 @@ export default class Options {
     get cookieJar(): PromiseCookieJar | ToughCookieJar | undefined;
     set cookieJar(value: PromiseCookieJar | ToughCookieJar | undefined);
     /**
+    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';
+
+    const abortController = new AbortController();
+
+    const request = got('https://httpbin.org/anything', {
+        signal: abortController.signal
+    });
+
+    setTimeout(() => {
+        abortController.abort();
+    }, 100);
+    ```
+    */
+    get signal(): any | undefined;
+    set signal(value: any | undefined);
+    /**
     Ignore invalid cookies instead of throwing an error.
     Only useful when the `cookieJar` option has been set. Not recommended.
 
@@ -1096,6 +1126,8 @@ export default class Options {
     set setHost(value: boolean);
     get maxHeaderSize(): number | undefined;
     set maxHeaderSize(value: number | undefined);
+    get enableUnixSockets(): boolean;
+    set enableUnixSockets(value: boolean);
     toJSON(): {
         headers: Headers;
         timeout: Delays;
@@ -1112,6 +1144,7 @@ export default class Options {
         form: Record<string, any> | undefined;
         url: string | URL | undefined;
         cookieJar: PromiseCookieJar | ToughCookieJar | undefined;
+        signal: any;
         ignoreInvalidCookies: boolean;
         searchParams: string | SearchParameters | URLSearchParams | undefined;
         dnsLookup: {
@@ -1147,6 +1180,7 @@ export default class Options {
         pagination: PaginationOptions<unknown, unknown>;
         setHost: boolean;
         maxHeaderSize: number | undefined;
+        enableUnixSockets: boolean;
     };
     createNativeRequestOptions(): {
         ALPNProtocols: string[] | undefined;

package/dist/source/core/options.js

@@ -9,9 +9,9 @@ import is, { assert } from '@sindresorhus/is';
 import lowercaseKeys from 'lowercase-keys';
 import CacheableLookup from 'cacheable-lookup';
 import http2wrapper from 'http2-wrapper';
-import { isFormDataLike } from 'form-data-encoder';
+import { isFormData } from 'form-data-encoder';
 import parseLinkHeader from './parse-link-header.js';
-const [major, minor] = process.versions.node.split('.').map(v => Number(v));
+const [major, minor] = process.versions.node.split('.').map(Number);
 function validateSearchParameters(searchParameters) {
     // eslint-disable-next-line guard-for-in
     for (const key in searchParameters) {
@@ -180,6 +180,8 @@ const defaultInternals = {
     },
     setHost: true,
     maxHeaderSize: undefined,
+    signal: undefined,
+    enableUnixSockets: true,
 };
 const cloneInternals = (internals) => {
     const { hooks, retry } = internals;
@@ -607,7 +609,7 @@ export default class Options {
         return this._internals.body;
     }
     set body(value) {
-        assert.any([is.string, is.buffer, is.nodeStream, is.generator, is.asyncGenerator, isFormDataLike, is.undefined], value);
+        assert.any([is.string, is.buffer, is.nodeStream, is.generator, is.asyncGenerator, isFormData, is.undefined], value);
         if (is.nodeStream(value)) {
             assert.truthy(value.readable);
         }
@@ -709,6 +711,9 @@ export default class Options {
             this._internals.searchParams = undefined;
         }
         if (url.hostname === 'unix') {
+            if (!this._internals.enableUnixSockets) {
+                throw new Error('Using UNIX domain sockets but option `enableUnixSockets` is not enabled');
+            }
             const matches = /(?<socketPath>.+?):(?<path>.+)/.exec(`${url.pathname}${url.search}`);
             if (matches?.groups) {
                 const { socketPath, path } = matches.groups;
@@ -756,6 +761,35 @@ 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';
+
+    const abortController = new AbortController();
+
+    const request = got('https://httpbin.org/anything', {
+        signal: abortController.signal
+    });
+
+    setTimeout(() => {
+        abortController.abort();
+    }, 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;
+    }
+    /**
     Ignore invalid cookies instead of throwing an error.
     Only useful when the `cookieJar` option has been set. Not recommended.
 
@@ -1498,6 +1532,13 @@ export default class Options {
         assert.any([is.number, is.undefined], value);
         this._internals.maxHeaderSize = value;
     }
+    get enableUnixSockets() {
+        return this._internals.enableUnixSockets;
+    }
+    set enableUnixSockets(value) {
+        assert.boolean(value);
+        this._internals.enableUnixSockets = value;
+    }
     // eslint-disable-next-line @typescript-eslint/naming-convention
     toJSON() {
         return { ...this._internals };

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

@@ -1,4 +1,5 @@
 /// <reference types="node" />
+/// <reference types="node" />
 import type { Buffer } from 'node:buffer';
 import type { URL } from 'node:url';
 import type { IncomingMessageWithTimings, Timings } from '@szmarczak/http-timer';
@@ -106,4 +107,4 @@ export declare class ParseError extends RequestError {
     readonly response: Response;
     constructor(error: Error, response: Response);
 }
-export declare const parseBody: (response: Response, responseType: ResponseType, parseJson: ParseJsonFunction, encoding?: BufferEncoding | undefined) => unknown;
+export declare const parseBody: (response: Response, responseType: ResponseType, parseJson: ParseJsonFunction, encoding?: BufferEncoding) => unknown;

package/dist/source/index.d.ts

@@ -7,7 +7,7 @@ export * from './core/response.js';
 export type { default as Request } from './core/index.js';
 export * from './core/index.js';
 export * from './core/errors.js';
-export { Delays } from './core/timed-out.js';
+export type { Delays } from './core/timed-out.js';
 export { default as calculateRetryDelay } from './core/calculate-retry-delay.js';
 export * from './as-promise/types.js';
 export * from './types.js';

package/dist/source/types.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="node" />
+/// <reference types="node" />
 import type { Buffer } from 'node:buffer';
 import type { URL } from 'node:url';
 import type { CancelableRequest } from './as-promise/types.js';
@@ -109,6 +110,8 @@ export interface GotPaginate {
 
     @example
     ```
+    import got from 'got';
+
     const countLimit = 10;
 
     const pagination = got.paginate('https://api.github.com/repos/sindresorhus/got/commits', {
@@ -130,6 +133,8 @@ export interface GotPaginate {
 
     @example
     ```
+    import got from 'got';
+
     const countLimit = 10;
 
     const results = await got.paginate.all('https://api.github.com/repos/sindresorhus/got/commits', {
@@ -203,6 +208,8 @@ export interface Got extends Record<HTTPAlias, GotRequestFunction>, GotRequestFu
 
     @example
     ```
+    import got from 'got';
+
     const countLimit = 10;
 
     const pagination = got.paginate('https://api.github.com/repos/sindresorhus/got/commits', {
@@ -234,6 +241,8 @@ export interface Got extends Record<HTTPAlias, GotRequestFunction>, GotRequestFu
 
     @example
     ```
+    import got from 'got';
+
     const client = got.extend({
         prefixUrl: 'https://example.com',
         headers: {

package/package.json

@@ -1,12 +1,13 @@
 {
 	"name": "got",
-	"version": "12.1.0",
+	"version": "12.3.1",
 	"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",
 	"engines": {
 		"node": ">=14.16"
 	},
@@ -44,14 +45,14 @@
 		"ky"
 	],
 	"dependencies": {
-		"@sindresorhus/is": "^4.6.0",
+		"@sindresorhus/is": "^5.2.0",
 		"@szmarczak/http-timer": "^5.0.1",
 		"@types/cacheable-request": "^6.0.2",
 		"@types/responselike": "^1.0.0",
 		"cacheable-lookup": "^6.0.4",
 		"cacheable-request": "^7.0.2",
 		"decompress-response": "^6.0.0",
-		"form-data-encoder": "1.7.1",
+		"form-data-encoder": "^2.0.1",
 		"get-stream": "^6.0.1",
 		"http2-wrapper": "^2.1.10",
 		"lowercase-keys": "^3.0.0",
@@ -59,12 +60,12 @@
 		"responselike": "^2.0.0"
 	},
 	"devDependencies": {
-		"@hapi/bourne": "^2.0.0",
+		"@hapi/bourne": "^3.0.0",
 		"@sindresorhus/tsconfig": "^2.0.0",
 		"@sinonjs/fake-timers": "^9.1.1",
 		"@types/benchmark": "^2.1.1",
 		"@types/express": "^4.17.13",
-		"@types/node": "^17.0.21",
+		"@types/node": "^18.0.1",
 		"@types/pem": "^1.9.6",
 		"@types/pify": "^5.0.1",
 		"@types/readable-stream": "^2.3.13",
@@ -73,7 +74,7 @@
 		"@types/sinonjs__fake-timers": "^8.1.1",
 		"@types/tough-cookie": "^4.0.1",
 		"ava": "^3.15.0",
-		"axios": "^0.26.1",
+		"axios": "^0.27.2",
 		"benchmark": "^2.1.4",
 		"bluebird": "^3.7.2",
 		"body-parser": "^1.19.2",
@@ -90,20 +91,19 @@
 		"nyc": "^15.1.0",
 		"p-event": "^5.0.1",
 		"pem": "^1.14.6",
-		"pify": "^5.0.0",
-		"readable-stream": "^3.6.0",
+		"pify": "^6.0.0",
+		"readable-stream": "^4.0.0",
 		"request": "^2.88.2",
-		"sinon": "^13.0.1",
+		"sinon": "^14.0.0",
 		"slow-stream": "0.0.4",
-		"tempy": "^2.0.0",
+		"tempy": "^3.0.0",
 		"then-busboy": "^5.1.1",
 		"to-readable-stream": "^3.0.0",
 		"tough-cookie": "^4.0.0",
-		"ts-node": "^10.7.0",
-		"typescript": "4.6.2",
-		"xo": "^0.48.0"
+		"ts-node": "^10.8.2",
+		"typescript": "^4.7.4",
+		"xo": "^0.50.0"
 	},
-	"types": "dist/source",
 	"sideEffects": false,
 	"ava": {
 		"files": [
@@ -140,9 +140,9 @@
 		],
 		"rules": {
 			"@typescript-eslint/no-empty-function": "off",
-			"node/no-deprecated-api": "off",
-			"node/prefer-global/url": "off",
-			"node/prefer-global/url-search-params": "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",
@@ -151,6 +151,7 @@
 			"@typescript-eslint/no-unsafe-assignment": "off",
 			"@typescript-eslint/no-unsafe-call": "off",
 			"@typescript-eslint/await-thenable": "off",
+			"@typescript-eslint/no-redundant-type-constituents": "off",
 			"no-lone-blocks": "off",
 			"unicorn/no-await-expression-member": "off"
 		}

package/readme.md

@@ -46,41 +46,6 @@
 		<br>
 		<br>
 		<br>
-		<a href="https://neverinstall.com/spaces/devtools?utm_source=github&utm_medium=sponsor&utm_campaign=sindre#gh-light-mode-only">
-			<div>
-				<img src="https://sindresorhus.com/assets/thanks/neverinstall-logo-light.svg" width="200" alt="neverinstall">
-			</div>
-			<br>
-			<b>All your favourite IDE's now available on the cloud</b>
-			<div>
-				<sub>
-				Neverinstall gives you an uninterrupted development experience and improved accessibility,
-				<br>
-				allowing you to code faster, better and on-the-go on your favourite IDEs like
-				<br>
-				Android Studio, VS Code, Jupyter and PyCharm using your browser.
-				</sub>
-			</div>
-		</a>
-		<a href="https://neverinstall.com/spaces/devtools?utm_source=github&utm_medium=sponsor&utm_campaign=sindre#gh-dark-mode-only">
-			<div>
-				<img src="https://sindresorhus.com/assets/thanks/neverinstall-logo-dark.svg" width="200" alt="neverinstall">
-			</div>
-			<br>
-			<b>All your favourite IDE's now available on the cloud</b>
-			<div>
-				<sub>
-				Neverinstall gives you an uninterrupted development experience and improved accessibility,
-				<br>
-				allowing you to code faster, better and on-the-go on your favourite IDEs like
-				<br>
-				Android Studio, VS Code, Jupyter and PyCharm using your browser.
-				</sub>
-			</div>
-		</a>
-		<br>
-		<br>
-		<br>
 		<a href="https://www.useanvil.com/?utm_source=sindresorhus#gh-light-mode-only">
 			<div>
 				<img src="https://sindresorhus.com/assets/thanks/anvil-logo-light.svg" width="200" alt="Anvil">
@@ -140,7 +105,7 @@ For browser usage, we recommend [Ky](https://github.com/sindresorhus/ky) by the
 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'll 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. You can also use [Got v11](https://github.com/sindresorhus/got/tree/v11.8.3) instead which is pretty stable.
+**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'll 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. You can also use [Got v11](https://github.com/sindresorhus/got/tree/v11.8.3) instead which is pretty stable. We will backport security fixes to v11 for the foreseeable future.
 
 ## Take a peek
 
@@ -168,12 +133,14 @@ For advanced JSON usage, check out the [`parseJson`](documentation/2-options.md#
 
 ## Highlights
 
-- [Used by 6K+ packages and 3M+ repos](https://github.com/sindresorhus/got/network/dependents)
+- [Used by 8K+ packages and 4M+ repos](https://github.com/sindresorhus/got/network/dependents)
 - [Actively maintained](https://github.com/sindresorhus/got/graphs/contributors)
 - [Trusted by many companies](#widely-used)
 
 ## Documentation
 
+By default, Got will retry on failure. To disable this option, set [`options.retry.limit`](documentation/7-retry.md#retry) to 0.
+
 #### Main API
 
 - [x] [Promise API](documentation/1-promise.md)
@@ -202,7 +169,7 @@ For advanced JSON usage, check out the [`parseJson`](documentation/2-options.md#
 
 - [x] [RFC compliant caching](documentation/cache.md)
 - [x] [Proxy support](documentation/tips.md#proxying)
-- [x] [Unix Domain Sockets](documentation/tips.md#unix)
+- [x] [Unix Domain Sockets](documentation/2-options.md#enableunixsockets)
 
 #### Integration