got 11.5.1 → 11.6.2

package/dist/source/create.js

@@ -7,11 +7,10 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
     o[k2] = m[k];
 }));
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !exports.hasOwnProperty(p)) __createBinding(exports, m, p);
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.defaultHandler = void 0;
-const p_cancelable_1 = require("p-cancelable");
 const is_1 = require("@sindresorhus/is");
 const as_promise_1 = require("./as-promise");
 const create_rejection_1 = require("./as-promise/create-rejection");
@@ -25,14 +24,23 @@ const errors = {
     MaxRedirectsError: as_promise_1.MaxRedirectsError,
     TimeoutError: as_promise_1.TimeoutError,
     ParseError: as_promise_1.ParseError,
-    CancelError: p_cancelable_1.CancelError,
+    CancelError: as_promise_1.CancelError,
     UnsupportedProtocolError: as_promise_1.UnsupportedProtocolError,
     UploadError: as_promise_1.UploadError
 };
 // The `delay` package weighs 10KB (!)
-const delay = async (ms) => new Promise(resolve => setTimeout(resolve, ms));
-const { normalizeArguments, mergeOptions } = as_promise_1.PromisableRequest;
-const getPromiseOrStream = (options) => options.isStream ? new core_1.default(options.url, options) : as_promise_1.default(options);
+const delay = async (ms) => new Promise(resolve => {
+    setTimeout(resolve, ms);
+});
+const { normalizeArguments } = core_1.default;
+const mergeOptions = (...sources) => {
+    let mergedOptions;
+    for (const source of sources) {
+        mergedOptions = normalizeArguments(undefined, source, mergedOptions);
+    }
+    return mergedOptions;
+};
+const getPromiseOrStream = (options) => options.isStream ? new core_1.default(undefined, options) : as_promise_1.default(options);
 const isGotInstance = (value) => ('defaults' in value && 'options' in value.defaults);
 const aliases = [
     'get',
@@ -74,7 +82,7 @@ const create = (defaults) => {
         return result;
     }));
     // Got interface
-    const got = ((url, options) => {
+    const got = ((url, options, _defaults) => {
         var _a, _b;
         let iteration = 0;
         const iterateHandlers = (newOptions) => {
@@ -101,7 +109,7 @@ const create = (defaults) => {
                 initHookError = error;
             }
             // Normalize options & call handlers
-            const normalizedOptions = normalizeArguments(url, options, defaults.options);
+            const normalizedOptions = normalizeArguments(url, options, _defaults !== null && _defaults !== void 0 ? _defaults : defaults.options);
             normalizedOptions[core_1.kIsNormalizedAlready] = true;
             if (initHookError) {
                 throw new as_promise_1.RequestError(initHookError.message, initHookError, normalizedOptions);
@@ -164,9 +172,10 @@ const create = (defaults) => {
                 // eslint-disable-next-line no-await-in-loop
                 await delay(pagination.backoff);
             }
+            // @ts-expect-error FIXME!
             // TODO: Throw when result is not an instance of Response
             // eslint-disable-next-line no-await-in-loop
-            const result = (await got(normalizedOptions));
+            const result = (await got(undefined, undefined, normalizedOptions));
             // eslint-disable-next-line no-await-in-loop
             const parsed = await pagination.transform(result);
             const current = [];
@@ -198,12 +207,10 @@ const create = (defaults) => {
             numberOfRequests++;
         }
     });
-    got.paginate = ((url, options) => {
-        return paginateEach(url, options);
-    });
+    got.paginate = paginateEach;
     got.paginate.all = (async (url, options) => {
         const results = [];
-        for await (const item of got.paginate(url, options)) {
+        for await (const item of paginateEach(url, options)) {
             results.push(item);
         }
         return results;
@@ -219,13 +226,14 @@ const create = (defaults) => {
             return got(url, { ...options, method, isStream: true });
         });
     }
-    Object.assign(got, { ...errors, mergeOptions });
+    Object.assign(got, errors);
     Object.defineProperty(got, 'defaults', {
         value: defaults.mutableDefaults ? defaults : deep_freeze_1.default(defaults),
         writable: defaults.mutableDefaults,
         configurable: defaults.mutableDefaults,
         enumerable: true
     });
+    got.mergeOptions = mergeOptions;
     return got;
 };
 exports.default = create;

package/dist/source/index.js

@@ -7,7 +7,7 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
     o[k2] = m[k];
 }));
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !exports.hasOwnProperty(p)) __createBinding(exports, m, p);
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const url_1 = require("url");
@@ -116,7 +116,8 @@ const defaults = {
             stackAllItems: true
         },
         parseJson: (text) => JSON.parse(text),
-        stringifyJson: (object) => JSON.stringify(object)
+        stringifyJson: (object) => JSON.stringify(object),
+        cacheOptions: {}
     },
     handlers: [create_1.defaultHandler],
     mutableDefaults: false

package/dist/source/types.d.ts

@@ -1,20 +1,62 @@
 /// <reference types="node" />
 import { URL } from 'url';
 import { CancelError } from 'p-cancelable';
-import { CancelableRequest, Response, Options, NormalizedOptions, Defaults as DefaultOptions, PaginationOptions, ParseError, RequestError, CacheError, ReadError, HTTPError, MaxRedirectsError, TimeoutError } from './as-promise';
+import { CancelableRequest, Response, Options, NormalizedOptions, Defaults as DefaultOptions, PaginationOptions, ParseError, RequestError, CacheError, ReadError, HTTPError, MaxRedirectsError, TimeoutError, UnsupportedProtocolError, UploadError } from './as-promise';
 import Request from './core';
 declare type Except<ObjectType, KeysType extends keyof ObjectType> = Pick<ObjectType, Exclude<keyof ObjectType, KeysType>>;
 declare type Merge<FirstType, SecondType> = Except<FirstType, Extract<keyof FirstType, keyof SecondType>> & SecondType;
+/**
+Defaults for each Got instance.
+*/
 export interface InstanceDefaults {
+    /**
+  An object containing the default options of Got.
+    */
     options: DefaultOptions;
+    /**
+    An array of functions. You execute them directly by calling `got()`.
+    They are some sort of "global hooks" - these functions are called first.
+    The last handler (*it's hidden*) is either `asPromise` or `asStream`, depending on the `options.isStream` property.
+
+    @default []
+    */
     handlers: HandlerFunction[];
+    /**
+    A read-only boolean describing whether the defaults are mutable or not.
+    If set to `true`, you can update headers over time, for example, update an access token when it expires.
+
+    @default false
+    */
     mutableDefaults: boolean;
     _rawHandlers?: HandlerFunction[];
 }
+/**
+A Request object returned by calling Got, or any of the Got HTTP alias request functions.
+*/
 export declare type GotReturn = Request | CancelableRequest;
+/**
+A function to handle options and returns a Request object.
+It acts sort of like a "global hook", and will be called before any actual request is made.
+*/
 export declare type HandlerFunction = <T extends GotReturn>(options: NormalizedOptions, next: (options: NormalizedOptions) => T) => T | Promise<T>;
+/**
+The options available for `got.extend()`.
+*/
 export interface ExtendOptions extends Options {
+    /**
+    An array of functions. You execute them directly by calling `got()`.
+    They are some sort of "global hooks" - these functions are called first.
+    The last handler (*it's hidden*) is either `asPromise` or `asStream`, depending on the `options.isStream` property.
+
+    @default []
+    */
     handlers?: HandlerFunction[];
+    /**
+    A read-only boolean describing whether the defaults are mutable or not.
+    If set to `true`, you can update headers over time, for example, update an access token when it expires.
+
+    @default false
+    */
     mutableDefaults?: boolean;
 }
 export declare type OptionsOfTextResponseBody = Merge<Options, {
@@ -44,10 +86,60 @@ declare type ResponseBodyOnly = {
     resolveBodyOnly: true;
 };
 export declare type OptionsWithPagination<T = unknown, R = unknown> = Merge<Options, PaginationOptions<T, R>>;
+/**
+An instance of `got.paginate`.
+*/
 export interface GotPaginate {
+    /**
+    Returns an async iterator.
+
+    See pagination.options for more pagination options.
+
+    @example
+    ```
+    (async () => {
+        const countLimit = 10;
+
+        const pagination = got.paginate('https://api.github.com/repos/sindresorhus/got/commits', {
+            pagination: {countLimit}
+        });
+
+        console.log(`Printing latest ${countLimit} Got commits (newest to oldest):`);
+
+        for await (const commitData of pagination) {
+            console.log(commitData.commit.message);
+        }
+    })();
+    ```
+    */
     each: (<T, R = unknown>(url: string | URL, options?: OptionsWithPagination<T, R>) => AsyncIterableIterator<T>) & (<T, R = unknown>(options?: OptionsWithPagination<T, R>) => AsyncIterableIterator<T>);
+    /**
+    Returns a Promise for an array of all results.
+
+    See pagination.options for more pagination options.
+
+    @example
+    ```
+    (async () => {
+        const countLimit = 10;
+
+        const results = await got.paginate.all('https://api.github.com/repos/sindresorhus/got/commits', {
+            pagination: {countLimit}
+        });
+
+        console.log(`Printing latest ${countLimit} Got commits (newest to oldest):`);
+        console.log(results);
+    })();
+    ```
+    */
     all: (<T, R = unknown>(url: string | URL, options?: OptionsWithPagination<T, R>) => Promise<T[]>) & (<T, R = unknown>(options?: OptionsWithPagination<T, R>) => Promise<T[]>);
+    /**
+    Same as `GotPaginate.each`.
+    */
     <T, R = unknown>(url: string | URL, options?: OptionsWithPagination<T, R>): AsyncIterableIterator<T>;
+    /**
+    Same as `GotPaginate.each`.
+    */
     <T, R = unknown>(options?: OptionsWithPagination<T, R>): AsyncIterableIterator<T>;
 }
 export interface GotRequestFunction {
@@ -74,6 +166,9 @@ export interface GotRequestFunction {
     (url: string | URL, options?: Options): CancelableRequest | Request;
     (options: Options): CancelableRequest | Request;
 }
+/**
+All available HTTP request methods provided by Got.
+*/
 export declare type HTTPAlias = 'get' | 'post' | 'put' | 'patch' | 'head' | 'delete';
 interface GotStreamFunction {
     (url: string | URL, options?: Merge<Options, {
@@ -83,21 +178,165 @@ interface GotStreamFunction {
         isStream?: true;
     }>): Request;
 }
+/**
+An instance of `got.stream()`.
+*/
 export declare type GotStream = GotStreamFunction & Record<HTTPAlias, GotStreamFunction>;
+/**
+An instance of `got`.
+*/
 export interface Got extends Record<HTTPAlias, GotRequestFunction>, GotRequestFunction {
+    /**
+    Sets `options.isStream` to `true`.
+
+    Returns a [duplex stream](https://nodejs.org/api/stream.html#stream_class_stream_duplex) with additional events:
+    - request
+    - response
+    - redirect
+    - uploadProgress
+    - downloadProgress
+    - error
+    */
     stream: GotStream;
+    /**
+    Returns an async iterator.
+
+    See pagination.options for more pagination options.
+
+    @example
+    ```
+    (async () => {
+        const countLimit = 10;
+
+        const pagination = got.paginate('https://api.github.com/repos/sindresorhus/got/commits', {
+            pagination: {countLimit}
+        });
+
+        console.log(`Printing latest ${countLimit} Got commits (newest to oldest):`);
+
+        for await (const commitData of pagination) {
+            console.log(commitData.commit.message);
+        }
+    })();
+    ```
+    */
     paginate: GotPaginate;
+    /**
+    The Got defaults used in that instance.
+    */
     defaults: InstanceDefaults;
+    /**
+    An error to be thrown when a cache method fails.
+    For example, if the database goes down or there's a filesystem error.
+    */
     CacheError: typeof CacheError;
+    /**
+    An error to be thrown when a request fails.
+    Contains a `code` property with error class code, like `ECONNREFUSED`.
+    */
     RequestError: typeof RequestError;
+    /**
+    An error to be thrown when reading from response stream fails.
+    */
     ReadError: typeof ReadError;
+    /**
+    An error to be thrown when server response code is 2xx, and parsing body fails.
+    Includes a `response` property.
+    */
     ParseError: typeof ParseError;
+    /**
+    An error to be thrown when the server response code is not 2xx nor 3xx if `options.followRedirect` is `true`, but always except for 304.
+    Includes a `response` property.
+    */
     HTTPError: typeof HTTPError;
+    /**
+    An error to be thrown when the server redirects you more than ten times.
+    Includes a `response` property.
+    */
     MaxRedirectsError: typeof MaxRedirectsError;
+    /**
+    An error to be thrown when given an unsupported protocol.
+    */
+    UnsupportedProtocolError: typeof UnsupportedProtocolError;
+    /**
+    An error to be thrown when the request is aborted due to a timeout.
+    Includes an `event` and `timings` property.
+    */
     TimeoutError: typeof TimeoutError;
+    /**
+    An error to be thrown when the request body is a stream and an error occurs while reading from that stream.
+    */
+    UploadError: typeof UploadError;
+    /**
+    An error to be thrown when the request is aborted with `.cancel()`.
+    */
     CancelError: typeof CancelError;
+    /**
+    Configure a new `got` instance with default `options`.
+    The `options` are merged with the parent instance's `defaults.options` using `got.mergeOptions`.
+    You can access the resolved options with the `.defaults` property on the instance.
+
+    Additionally, `got.extend()` accepts two properties from the `defaults` object: `mutableDefaults` and `handlers`.
+
+    It is also possible to merges many instances into a single one:
+    - options are merged using `got.mergeOptions()` (including hooks),
+    - handlers are stored in an array (you can access them through `instance.defaults.handlers`).
+
+    @example
+    ```js
+    const client = got.extend({
+        prefixUrl: 'https://example.com',
+        headers: {
+            'x-unicorn': 'rainbow'
+        }
+    });
+
+    client.get('demo');
+
+    // HTTP Request =>
+    // GET /demo HTTP/1.1
+    // Host: example.com
+    // x-unicorn: rainbow
+    ```
+    */
     extend: (...instancesOrOptions: Array<Got | ExtendOptions>) => Got;
+    /**
+    Merges multiple `got` instances into the parent.
+    */
     mergeInstances: (parent: Got, ...instances: Got[]) => Got;
+    /**
+    Extends parent options.
+    Avoid using [object spread](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Spread_syntax#Spread_in_object_literals) as it doesn't work recursively.
+
+    Options are deeply merged to a new object. The value of each key is determined as follows:
+
+    - If the new property is not defined, the old value is used.
+    - If the new property is explicitly set to `undefined`:
+        - If the parent property is a plain `object`, the parent value is deeply cloned.
+        - Otherwise, `undefined` is used.
+    - If the parent value is an instance of `URLSearchParams`:
+        - If the new value is a `string`, an `object` or an instance of `URLSearchParams`, a new `URLSearchParams` instance is created.
+            The values are merged using [`urlSearchParams.append(key, value)`](https://developer.mozilla.org/en-US/docs/Web/API/URLSearchParams/append).
+            The keys defined in the new value override the keys defined in the parent value.
+        - Otherwise, the only available value is `undefined`.
+    - If the new property is a plain `object`:
+        - If the parent property is a plain `object` too, both values are merged recursively into a new `object`.
+        - Otherwise, only the new value is deeply cloned.
+    - If the new property is an `Array`, it overwrites the old one with a deep clone of the new property.
+    - Properties that are not enumerable, such as `context`, `body`, `json`, and `form`, will not be merged.
+    - Otherwise, the new value is assigned to the key.
+
+    **Note:** Only Got options are merged! Custom user options should be defined via [`options.context`](#context).
+
+    @example
+    ```
+    const a = {headers: {cat: 'meow', wolf: ['bark', 'wrrr']}};
+    const b = {headers: {cow: 'moo', wolf: ['auuu']}};
+
+    {...a, ...b}            // => {headers: {cow: 'moo', wolf: ['auuu']}}
+    got.mergeOptions(a, b)  // => {headers: {cat: 'meow', cow: 'moo', wolf: ['auuu']}}
+    ```
+    */
     mergeOptions: (...sources: Options[]) => NormalizedOptions;
 }
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "got",
-	"version": "11.5.1",
+	"version": "11.6.2",
 	"description": "Human-friendly and powerful HTTP request library for Node.js",
 	"license": "MIT",
 	"repository": "sindresorhus/got",
@@ -43,14 +43,14 @@
 		"ky"
 	],
 	"dependencies": {
-		"@sindresorhus/is": "^3.0.0",
+		"@sindresorhus/is": "^3.1.1",
 		"@szmarczak/http-timer": "^4.0.5",
 		"@types/cacheable-request": "^6.0.1",
 		"@types/responselike": "^1.0.0",
 		"cacheable-lookup": "^5.0.3",
 		"cacheable-request": "^7.0.1",
 		"decompress-response": "^6.0.0",
-		"http2-wrapper": "^1.0.0-beta.5.0",
+		"http2-wrapper": "^1.0.0-beta.5.2",
 		"lowercase-keys": "^2.0.0",
 		"p-cancelable": "^2.0.0",
 		"responselike": "^2.0.0"
@@ -60,34 +60,38 @@
 		"@sindresorhus/tsconfig": "^0.7.0",
 		"@sinonjs/fake-timers": "^6.0.1",
 		"@types/benchmark": "^1.0.33",
-		"@types/express": "^4.17.6",
-		"@types/node": "^14.0.14",
+		"@types/express": "^4.17.7",
+		"@types/node": "^14.6.0",
 		"@types/node-fetch": "^2.5.7",
+		"@types/pem": "^1.9.5",
+		"@types/pify": "^3.0.2",
 		"@types/request": "^2.48.5",
-		"@types/sinon": "^9.0.4",
+		"@types/sinon": "^9.0.5",
 		"@types/tough-cookie": "^4.0.0",
-		"ava": "^3.10.0",
-		"axios": "^0.19.2",
+		"ava": "^3.11.1",
+		"axios": "^0.20.0",
 		"benchmark": "^2.1.4",
 		"coveralls": "^3.1.0",
 		"create-test-server": "^3.0.1",
 		"del-cli": "^3.0.1",
-		"delay": "^4.3.0",
+		"delay": "^4.4.0",
 		"express": "^4.17.1",
 		"form-data": "^3.0.0",
-		"get-stream": "^5.1.0",
-		"nock": "^13.0.2",
+		"get-stream": "^6.0.0",
+		"nock": "^13.0.4",
 		"node-fetch": "^2.6.0",
-		"np": "^6.3.0",
+		"np": "^6.4.0",
 		"nyc": "^15.1.0",
 		"p-event": "^4.2.0",
-		"sinon": "^9.0.2",
+		"pem": "^1.14.4",
+		"pify": "^5.0.0",
+		"sinon": "^9.0.3",
 		"slow-stream": "0.0.4",
-		"tempy": "^0.5.0",
+		"tempy": "^0.6.0",
 		"to-readable-stream": "^2.1.0",
 		"tough-cookie": "^4.0.0",
-		"typescript": "3.9.6",
-		"xo": "^0.32.1"
+		"typescript": "^4.0.2",
+		"xo": "^0.33.0"
 	},
 	"types": "dist/source",
 	"sideEffects": false,