got 12.3.1 → 12.4.0

package/dist/source/as-promise/index.d.ts

@@ -1,3 +1,3 @@
 import Request from '../core/index.js';
-import type { CancelableRequest } from './types.js';
+import { type CancelableRequest } from './types.js';
 export default function asPromise<T>(firstRequest?: Request): CancelableRequest<T>;

package/dist/source/as-promise/types.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 import type { Buffer } from 'node:buffer';
-import PCancelable from 'p-cancelable';
+import type PCancelable from 'p-cancelable';
 import { RequestError } from '../core/errors.js';
 import type Request from '../core/index.js';
 import type { RequestEvents } from '../core/index.js';

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

@@ -12,17 +12,15 @@ import type { Socket } from 'node:net';
 import CacheableRequest from 'cacheable-request';
 import type { Timings } from '@szmarczak/http-timer';
 import type ResponseLike from 'responselike';
-import Options from './options.js';
-import { Response } from './response.js';
+import Options, { type NativeRequestOptions } from './options.js';
+import { type PlainResponse, type Response } from './response.js';
 import { RequestError } from './errors.js';
-import type { PlainResponse } from './response.js';
-import type { NativeRequestOptions } from './options.js';
 declare type Error = NodeJS.ErrnoException;
-export interface Progress {
+export declare type Progress = {
     percent: number;
     transferred: number;
     total?: number;
-}
+};
 export declare type GotEventFunction<T> = 
 /**
 `request` event to get the request object of the request.
@@ -84,11 +82,11 @@ When this event is emitted, you should reset the stream you were writing to and
 See `got.options.retry` for more information.
 */
  & ((name: 'retry', listener: (retryCount: number, error: RequestError) => void) => T);
-export interface RequestEvents<T> {
+export declare type 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];
 declare type OptionsType = ConstructorParameters<typeof Options>[1];

package/dist/source/core/index.js

@@ -501,7 +501,9 @@ export default class Request extends Duplex {
                     if (noContentType) {
                         headers['content-type'] = encoder.headers['Content-Type'];
                     }
-                    headers['content-length'] = encoder.headers['Content-Length'];
+                    if ('Content-Length' in encoder.headers) {
+                        headers['content-length'] = encoder.headers['Content-Length'];
+                    }
                     options.body = encoder.encode();
                 }
                 // Special case for https://github.com/form-data/form-data
@@ -680,6 +682,10 @@ export default class Request extends Duplex {
             }
             return;
         }
+        // `HTTPError`s always have `error.response.body` defined.
+        // Therefore we cannot retry if `options.throwHttpErrors` is false.
+        // On the last retry, if `options.throwHttpErrors` is false, we would need to return the body,
+        // but that wouldn't be possible since the body would be already read in `error.response.body`.
         if (options.isStream && options.throwHttpErrors && !isResponseOk(typedResponse)) {
             this._beforeError(new HTTPError(typedResponse));
             return;
@@ -969,9 +975,16 @@ export default class Request extends Duplex {
     }
     async _error(error) {
         try {
-            for (const hook of this.options.hooks.beforeError) {
-                // eslint-disable-next-line no-await-in-loop
-                error = await hook(error);
+            if (error instanceof HTTPError && !this.options.throwHttpErrors) {
+                // This branch can be reached only when using the Promise API
+                // Skip calling the hooks on purpose.
+                // See https://github.com/sindresorhus/got/issues/2103
+            }
+            else {
+                for (const hook of this.options.hooks.beforeError) {
+                    // eslint-disable-next-line no-await-in-loop
+                    error = await hook(error);
+                }
             }
         }
         catch (error_) {

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

@@ -7,7 +7,7 @@
 /// <reference types="node" />
 /// <reference types="node" />
 /// <reference types="node" />
-import { Buffer } from 'node:buffer';
+import type { Buffer } from 'node:buffer';
 import { URL, URLSearchParams } from 'node:url';
 import { checkServerIdentity } from 'node:tls';
 import http from 'node:http';
@@ -18,7 +18,7 @@ import type { SecureContextOptions, DetailedPeerCertificate } from 'node:tls';
 import type { Agent as HttpAgent, ClientRequest } from 'node:http';
 import type { RequestOptions as HttpsRequestOptions, Agent as HttpsAgent } from 'node:https';
 import CacheableLookup from 'cacheable-lookup';
-import http2wrapper, { ClientHttp2Session } from 'http2-wrapper';
+import http2wrapper, { type ClientHttp2Session } from 'http2-wrapper';
 import type { FormDataLike } from 'form-data-encoder';
 import type CacheableRequest from 'cacheable-request';
 import type ResponseLike from 'responselike';
@@ -36,20 +36,20 @@ export declare type NativeRequestOptions = HttpsRequestOptions & CacheOptions &
 declare type AcceptableResponse = IncomingMessageWithTimings | ResponseLike;
 declare type AcceptableRequestResult = Promisable<AcceptableResponse | ClientRequest> | undefined;
 export declare type RequestFunction = (url: URL, options: NativeRequestOptions, callback?: (response: AcceptableResponse) => void) => AcceptableRequestResult;
-export interface Agents {
+export declare type Agents = {
     http?: HttpAgent | false;
     https?: HttpsAgent | false;
     http2?: unknown | false;
-}
+};
 export declare type Headers = Record<string, string | string[] | undefined>;
-export interface ToughCookieJar {
+export declare type ToughCookieJar = {
     getCookieString: ((currentUrl: string, options: Record<string, unknown>, cb: (error: 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: (error: Error | null, cookie: unknown) => void) => void) & ((rawCookie: string, url: string, callback: (error: Error | null, result: unknown) => void) => void);
-}
-export interface PromiseCookieJar {
+};
+export declare type PromiseCookieJar = {
     getCookieString: (url: string) => Promise<string>;
     setCookie: (rawCookie: string, url: string) => Promise<unknown>;
-}
+};
 export declare type InitHook = (init: OptionsInit, self: Options) => void;
 export declare type BeforeRequestHook = (options: Options) => Promisable<void | Response | ResponseLike>;
 export declare type BeforeRedirectHook = (updatedOptions: Options, plainResponse: PlainResponse) => Promisable<void>;
@@ -59,7 +59,7 @@ export declare type AfterResponseHook<ResponseType = unknown> = (response: Respo
 /**
 All available hooks of Got.
 */
-export interface Hooks {
+export declare type Hooks = {
     /**
     Called with the plain request options, right before their normalization.
 
@@ -327,20 +327,20 @@ export interface Hooks {
     ```
     */
     afterResponse: AfterResponseHook[];
-}
+};
 export declare type ParseJsonFunction = (text: string) => unknown;
 export declare type StringifyJsonFunction = (object: unknown) => string;
 /**
 All available HTTP request methods provided by Got.
 */
 export declare type Method = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'HEAD' | 'DELETE' | 'OPTIONS' | 'TRACE' | 'get' | 'post' | 'put' | 'patch' | 'head' | 'delete' | 'options' | 'trace';
-export interface RetryObject {
+export declare type RetryObject = {
     attemptCount: number;
     retryOptions: RetryOptions;
     error: RequestError;
     computedValue: number;
     retryAfter?: number;
-}
+};
 export declare type RetryFunction = (retryObject: RetryObject) => Promisable<number>;
 /**
 An object representing `limit`, `calculateDelay`, `methods`, `statusCodes`, `maxRetryAfter` and `errorCodes` fields for maximum retry count, retry handler, allowed methods, allowed status codes, maximum [`Retry-After`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After) time and allowed error codes.
@@ -364,7 +364,7 @@ __Note:__ Got does not retry on `POST` by default.
 __Note:__ If `maxRetryAfter` is set to `undefined`, it will use `options.timeout`.
 __Note:__ If [`Retry-After`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After) header is greater than `maxRetryAfter`, it will cancel the request.
 */
-export interface RetryOptions {
+export declare type RetryOptions = {
     limit: number;
     methods: Method[];
     statusCodes: number[];
@@ -373,21 +373,21 @@ export interface RetryOptions {
     backoffLimit: number;
     noise: number;
     maxRetryAfter?: number;
-}
+};
 export declare type CreateConnectionFunction = (options: NativeRequestOptions, oncreate: (error: NodeJS.ErrnoException, socket: Socket) => void) => Socket;
 export declare type CheckServerIdentityFunction = (hostname: string, certificate: DetailedPeerCertificate) => NodeJS.ErrnoException | void;
-export interface CacheOptions {
+export declare type CacheOptions = {
     shared?: boolean;
     cacheHeuristic?: number;
     immutableMinTimeToLive?: number;
     ignoreCargoCult?: boolean;
-}
+};
 declare type PfxObject = {
     buffer: string | Buffer;
     passphrase?: string | undefined;
 };
 declare type PfxType = string | Buffer | Array<string | Buffer | PfxObject> | undefined;
-export interface HttpsOptions {
+export declare type HttpsOptions = {
     alpnProtocols?: string[];
     rejectUnauthorized?: NativeRequestOptions['rejectUnauthorized'];
     checkServerIdentity?: CheckServerIdentityFunction;
@@ -438,21 +438,21 @@ export interface HttpsOptions {
     dhparam?: SecureContextOptions['dhparam'];
     ecdhCurve?: SecureContextOptions['ecdhCurve'];
     certificateRevocationLists?: SecureContextOptions['crl'];
-}
-export interface PaginateData<BodyType, ElementType> {
+};
+export declare type PaginateData<BodyType, ElementType> = {
     response: Response<BodyType>;
     currentItems: ElementType[];
     allItems: ElementType[];
-}
-export interface FilterData<ElementType> {
+};
+export declare type FilterData<ElementType> = {
     item: ElementType;
     currentItems: ElementType[];
     allItems: ElementType[];
-}
+};
 /**
 All options accepted by `got.paginate()`.
 */
-export interface PaginationOptions<ElementType, BodyType> {
+export declare type PaginationOptions<ElementType, BodyType> = {
     /**
     A function that transform [`Response`](#response) into an array of items.
     This is where you should do the parsing.
@@ -550,7 +550,7 @@ export interface PaginationOptions<ElementType, BodyType> {
     @default false
     */
     stackAllItems?: boolean;
-}
+};
 export declare type SearchParameters = Record<string, string | number | boolean | null | undefined>;
 /**
 All parsing methods supported by Got.

package/dist/source/core/options.js

@@ -464,6 +464,7 @@ export default class Options {
             if (!(key in this._internals.agent)) {
                 throw new TypeError(`Unexpected agent option: ${key}`);
             }
+            // @ts-expect-error - No idea why `value[key]` doesn't work here.
             assert.any([is.object, is.undefined], value[key]);
         }
         if (this._merging) {
@@ -523,6 +524,7 @@ export default class Options {
             if (!(key in this._internals.timeout)) {
                 throw new Error(`Unexpected timeout option: ${key}`);
             }
+            // @ts-expect-error - No idea why `value[key]` doesn't work here.
             assert.any([is.number, is.undefined], value[key]);
         }
         if (this._merging) {
@@ -976,8 +978,7 @@ export default class Options {
                 throw new Error(`Unexpected hook event: ${knownHookEvent}`);
             }
             const typedKnownHookEvent = knownHookEvent;
-            const typedValue = value;
-            const hooks = typedValue[typedKnownHookEvent];
+            const hooks = value[typedKnownHookEvent];
             assert.any([is.array, is.undefined], hooks);
             if (hooks) {
                 for (const hook of hooks) {

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

@@ -6,7 +6,7 @@ import type { IncomingMessageWithTimings, Timings } from '@szmarczak/http-timer'
 import { RequestError } from './errors.js';
 import type { ParseJsonFunction, ResponseType } from './options.js';
 import type Request from './index.js';
-export interface PlainResponse extends IncomingMessageWithTimings {
+export declare type PlainResponse = {
     /**
     The original request URL.
     */
@@ -87,8 +87,8 @@ export interface PlainResponse extends IncomingMessageWithTimings {
     __Note__: Got throws automatically when `response.ok` is `false` and `throwHttpErrors` is `true`.
     */
     ok: boolean;
-}
-export interface Response<T = unknown> extends PlainResponse {
+} & IncomingMessageWithTimings;
+export declare type Response<T = unknown> = {
     /**
     The result of the request.
     */
@@ -97,7 +97,7 @@ export interface Response<T = unknown> extends PlainResponse {
     The raw result of the request.
     */
     rawBody: Buffer;
-}
+} & PlainResponse;
 export declare const isResponseOk: (response: PlainResponse) => boolean;
 /**
 An error to be thrown when server response code is 2xx, and parsing body fails.

package/dist/source/core/timed-out.d.ts

@@ -1,11 +1,11 @@
-import { ClientRequest } from 'node:http';
+import type { ClientRequest } from 'node:http';
 declare const reentry: unique symbol;
-interface TimedOutOptions {
+declare type TimedOutOptions = {
     host?: string;
     hostname?: string;
     protocol?: string;
-}
-export interface Delays {
+};
+export declare type Delays = {
     lookup?: number;
     socket?: number;
     connect?: number;
@@ -14,7 +14,7 @@ export interface Delays {
     response?: number;
     read?: number;
     request?: number;
-}
+};
 export declare type ErrorCode = 'ETIMEDOUT' | 'ECONNRESET' | 'EADDRINUSE' | 'ECONNREFUSED' | 'EPIPE' | 'ENOTFOUND' | 'ENETUNREACH' | 'EAI_AGAIN';
 export declare class TimeoutError extends Error {
     event: string;

package/dist/source/core/utils/get-body-size.d.ts

@@ -1,3 +1,3 @@
 /// <reference types="node" />
-import { ClientRequestArgs } from 'node:http';
+import type { ClientRequestArgs } from 'node:http';
 export default function getBodySize(body: unknown, headers: ClientRequestArgs['headers']): Promise<number | undefined>;

package/dist/source/core/utils/is-form-data.d.ts

@@ -1,8 +1,8 @@
 /// <reference types="node" />
-import { Readable } from 'node:stream';
-interface FormData extends Readable {
+import type { Readable } from 'node:stream';
+declare type FormData = {
     getBoundary: () => string;
     getLength: (callback: (error: Error | null, length: number) => void) => void;
-}
+} & Readable;
 export default function isFormData(body: unknown): body is FormData;
 export {};

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

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

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

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 import { URL } from 'node:url';
-export interface URLOptions {
+export declare type URLOptions = {
     href?: string;
     protocol?: string;
     host?: string;
@@ -10,5 +10,5 @@ export interface URLOptions {
     search?: string;
     searchParams?: unknown;
     path?: string;
-}
+};
 export default function optionsToUrl(origin: string, options: URLOptions): URL;

package/dist/source/core/utils/proxy-events.d.ts

@@ -1,3 +1,3 @@
 /// <reference types="node" />
-import { EventEmitter } from 'node:events';
+import type { EventEmitter } from 'node:events';
 export default function proxyEvents(from: EventEmitter, to: EventEmitter, events: Readonly<string[]>): () => void;

package/dist/source/core/utils/unhandle.d.ts

@@ -1,11 +1,11 @@
 /// <reference types="node" />
-import { EventEmitter } from 'node:events';
+import type { EventEmitter } from 'node:events';
 declare type Origin = EventEmitter;
 declare type Event = string | symbol;
 declare type Fn = (...args: any[]) => void;
-interface Unhandler {
+declare type Unhandler = {
     once: (origin: Origin, event: Event, fn: Fn) => void;
     unhandleAll: () => void;
-}
+};
 export default function unhandle(): Unhandler;
 export {};

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

@@ -1,6 +1,6 @@
 /// <reference types="node" />
-import { URL, UrlWithStringQuery } from 'node:url';
-export interface LegacyUrlOptions {
+import type { URL, UrlWithStringQuery } from 'node:url';
+export declare type LegacyUrlOptions = {
     protocol: string;
     hostname: string;
     host: string;
@@ -11,5 +11,5 @@ export interface LegacyUrlOptions {
     path: string;
     port?: number;
     auth?: string;
-}
+};
 export default function urlToOptions(url: URL | UrlWithStringQuery): LegacyUrlOptions;

package/dist/source/create.d.ts

@@ -1,3 +1,3 @@
-import { Got, InstanceDefaults } from './types.js';
+import type { Got, InstanceDefaults } from './types.js';
 declare const create: (defaults: InstanceDefaults) => Got;
 export default create;

package/dist/source/types.d.ts

@@ -12,7 +12,7 @@ declare type Merge<FirstType, SecondType> = Except<FirstType, Extract<keyof Firs
 /**
 Defaults for each Got instance.
 */
-export interface InstanceDefaults {
+export declare type InstanceDefaults = {
     /**
     An object containing the default options of Got.
     */
@@ -32,7 +32,7 @@ export interface InstanceDefaults {
     @default false
     */
     mutableDefaults: boolean;
-}
+};
 /**
 A Request object returned by calling Got, or any of the Got HTTP alias request functions.
 */
@@ -45,7 +45,7 @@ export declare type HandlerFunction = <T extends GotReturn>(options: Options, ne
 /**
 The options available for `got.extend()`.
 */
-export interface ExtendOptions extends OptionsInit {
+export declare type ExtendOptions = {
     /**
     An array of functions. You execute them directly by calling `got()`.
     They are some sort of "global hooks" - these functions are called first.
@@ -61,7 +61,7 @@ export interface ExtendOptions extends OptionsInit {
     @default false
     */
     mutableDefaults?: boolean;
-}
+} & OptionsInit;
 export declare type OptionsOfTextResponseBody = Merge<OptionsInit, {
     isStream?: false;
     resolveBodyOnly?: false;
@@ -94,7 +94,7 @@ export declare type OptionsWithPagination<T = unknown, R = unknown> = Merge<Opti
 /**
 An instance of `got.paginate`.
 */
-export interface GotPaginate {
+export declare type GotPaginate = {
     /**
     Same as `GotPaginate.each`.
     */
@@ -146,8 +146,8 @@ export interface GotPaginate {
     ```
     */
     all: (<T, R = unknown>(url: string | URL, options?: OptionsWithPagination<T, R>) => Promise<T[]>) & (<T, R = unknown>(options?: OptionsWithPagination<T, R>) => Promise<T[]>);
-}
-export interface GotRequestFunction {
+};
+export declare type GotRequestFunction = {
     (url: string | URL, options?: OptionsOfTextResponseBody): CancelableRequest<Response<string>>;
     <T>(url: string | URL, options?: OptionsOfJSONResponseBody): CancelableRequest<Response<T>>;
     (url: string | URL, options?: OptionsOfBufferResponseBody): CancelableRequest<Response<Buffer>>;
@@ -171,7 +171,7 @@ export interface GotRequestFunction {
     (url: string | URL, options?: OptionsInit): CancelableRequest | Request;
     (options: OptionsInit): CancelableRequest | Request;
     (url: undefined, options: undefined, defaults: Options): CancelableRequest | Request;
-}
+};
 /**
 All available HTTP request methods provided by Got.
 */
@@ -188,7 +188,7 @@ export declare type GotStream = GotStreamFunction & Record<HTTPAlias, GotStreamF
 /**
 An instance of `got`.
 */
-export interface Got extends Record<HTTPAlias, GotRequestFunction>, GotRequestFunction {
+export declare type Got = {
     /**
     Sets `options.isStream` to `true`.
 
@@ -259,5 +259,5 @@ export interface Got extends Record<HTTPAlias, GotRequestFunction>, GotRequestFu
     ```
     */
     extend: (...instancesOrOptions: Array<Got | ExtendOptions>) => Got;
-}
+} & Record<HTTPAlias, GotRequestFunction> & GotRequestFunction;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "got",
-	"version": "12.3.1",
+	"version": "12.4.0",
 	"description": "Human-friendly and powerful HTTP request library for Node.js",
 	"license": "MIT",
 	"repository": "sindresorhus/got",
@@ -12,7 +12,7 @@
 		"node": ">=14.16"
 	},
 	"scripts": {
-		"test": "xo && ava",
+		"test": "xo && tsc --noEmit && ava",
 		"release": "np",
 		"build": "del-cli dist && tsc",
 		"prepare": "npm run build"
@@ -48,24 +48,23 @@
 		"@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": "^2.0.1",
+		"form-data-encoder": "^2.1.0",
 		"get-stream": "^6.0.1",
 		"http2-wrapper": "^2.1.10",
 		"lowercase-keys": "^3.0.0",
 		"p-cancelable": "^3.0.0",
-		"responselike": "^2.0.0"
+		"responselike": "^3.0.0"
 	},
 	"devDependencies": {
 		"@hapi/bourne": "^3.0.0",
 		"@sindresorhus/tsconfig": "^2.0.0",
 		"@sinonjs/fake-timers": "^9.1.1",
-		"@types/benchmark": "^2.1.1",
+		"@types/benchmark": "^2.1.2",
 		"@types/express": "^4.17.13",
-		"@types/node": "^18.0.1",
+		"@types/node": "^18.7.13",
 		"@types/pem": "^1.9.6",
 		"@types/pify": "^5.0.1",
 		"@types/readable-stream": "^2.3.13",
@@ -80,7 +79,7 @@
 		"body-parser": "^1.19.2",
 		"create-cert": "^1.0.6",
 		"create-test-server": "^3.0.1",
-		"del-cli": "^4.0.1",
+		"del-cli": "^5.0.0",
 		"delay": "^5.0.0",
 		"express": "^4.17.3",
 		"form-data": "^4.0.0",
@@ -99,10 +98,10 @@
 		"tempy": "^3.0.0",
 		"then-busboy": "^5.1.1",
 		"to-readable-stream": "^3.0.0",
-		"tough-cookie": "^4.0.0",
+		"tough-cookie": "4.0.0",
 		"ts-node": "^10.8.2",
-		"typescript": "^4.7.4",
-		"xo": "^0.50.0"
+		"typescript": "~4.8.2",
+		"xo": "^0.52.2"
 	},
 	"sideEffects": false,
 	"ava": {

package/readme.md

@@ -109,6 +109,8 @@ npm install got
 
 ## Take a peek
 
+**A [quick start](documentation/quick-start.md) guide is available.**
+
 ### JSON mode
 
 Got has a dedicated option for handling JSON payload.\
@@ -149,7 +151,7 @@ By default, Got will retry on failure. To disable this option, set [`options.ret
 - [x] [Pagination API](documentation/4-pagination.md)
 - [x] [Advanced HTTPS API](documentation/5-https.md)
 - [x] [HTTP/2 support](documentation/2-options.md#http2)
-- [x] [`Response` class](documentation/3-streams.md#response-1)
+- [x] [`Response` class](documentation/3-streams.md#response-2)
 
 #### Timeouts and retries