got 10.5.7 → 10.6.0

package/dist/source/as-stream.js

@@ -21,7 +21,7 @@ function asStream(options) {
             throw new Error('Got\'s stream is not writable when the `body`, `json` or `form` option is used');
         };
     }
-    else if (options.method === 'POST' || options.method === 'PUT' || options.method === 'PATCH') {
+    else if (options.method === 'POST' || options.method === 'PUT' || options.method === 'PATCH' || (options.allowGetBody && options.method === 'GET')) {
         options.body = input;
     }
     else {

package/dist/source/index.js

@@ -67,6 +67,7 @@ const defaults = {
         maxRedirects: 10,
         prefixUrl: '',
         methodRewriting: true,
+        allowGetBody: false,
         ignoreInvalidCookies: false,
         context: {},
         _pagination: {

package/dist/source/normalize-arguments.js

@@ -193,6 +193,7 @@ exports.preNormalizeArguments = (options, defaults) => {
     options.dnsCache = (_e = options.dnsCache, (_e !== null && _e !== void 0 ? _e : false));
     options.useElectronNet = Boolean(options.useElectronNet);
     options.methodRewriting = Boolean(options.methodRewriting);
+    options.allowGetBody = Boolean(options.allowGetBody);
     options.context = (_f = options.context, (_f !== null && _f !== void 0 ? _f : {}));
     return options;
 };
@@ -305,7 +306,8 @@ exports.normalizeArguments = (url, options, defaults) => {
     }
     return normalizedOptions;
 };
-const withoutBody = new Set(['GET', 'HEAD']);
+const withoutBody = new Set(['HEAD']);
+const withoutBodyUnlessSpecified = 'GET';
 exports.normalizeRequestArguments = async (options) => {
     var _a, _b, _c;
     options = exports.mergeOptions(options);
@@ -320,6 +322,9 @@ exports.normalizeRequestArguments = async (options) => {
         if ((isBody || isForm || isJson) && withoutBody.has(options.method)) {
             throw new TypeError(`The \`${options.method}\` method cannot be used with a body`);
         }
+        if (!options.allowGetBody && (isBody || isForm || isJson) && withoutBodyUnlessSpecified === options.method) {
+            throw new TypeError(`The \`${options.method}\` method cannot be used with a body`);
+        }
         if ([isBody, isForm, isJson].filter(isTrue => isTrue).length > 1) {
             throw new TypeError('The `body`, `json` and `form` options are mutually exclusive');
         }
@@ -366,7 +371,7 @@ exports.normalizeRequestArguments = async (options) => {
     // a payload body and the method semantics do not anticipate such a
     // body.
     if (is_1.default.undefined(headers['content-length']) && is_1.default.undefined(headers['transfer-encoding'])) {
-        if ((options.method === 'POST' || options.method === 'PUT' || options.method === 'PATCH' || options.method === 'DELETE') &&
+        if ((options.method === 'POST' || options.method === 'PUT' || options.method === 'PATCH' || options.method === 'DELETE' || (options.allowGetBody && options.method === 'GET')) &&
             !is_1.default.undefined(uploadBodySize)) {
             // @ts-ignore We assign if it is undefined, so this IS correct
             headers['content-length'] = String(uploadBodySize);

package/dist/source/types.d.ts

@@ -145,6 +145,7 @@ export interface GotOptions extends PaginationOptions<unknown> {
     };
     maxRedirects?: number;
     lookup?: CacheableLookup['lookup'];
+    allowGetBody?: boolean;
     methodRewriting?: boolean;
 }
 export declare type Options = Merge<https.RequestOptions, Merge<GotOptions, URLOptions>>;
@@ -173,6 +174,7 @@ export interface NormalizedOptions extends Options {
     followRedirect: boolean;
     useElectronNet: boolean;
     methodRewriting: boolean;
+    allowGetBody: boolean;
     context: {
         [key: string]: any;
     };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "got",
-	"version": "10.5.7",
+	"version": "10.6.0",
 	"description": "Human-friendly and powerful HTTP request library for Node.js",
 	"license": "MIT",
 	"repository": "sindresorhus/got",
@@ -50,7 +50,7 @@
 		"duplexer3": "^0.1.4",
 		"get-stream": "^5.0.0",
 		"lowercase-keys": "^2.0.0",
-		"mimic-response": "^2.0.0",
+		"mimic-response": "^2.1.0",
 		"p-cancelable": "^2.0.0",
 		"p-event": "^4.0.0",
 		"responselike": "^2.0.0",
@@ -58,7 +58,7 @@
 		"type-fest": "^0.10.0"
 	},
 	"devDependencies": {
-		"@ava/typescript": "^1.1.0",
+		"@ava/typescript": "^1.1.1",
 		"@sindresorhus/tsconfig": "^0.7.0",
 		"@types/duplexer3": "^0.1.0",
 		"@types/express": "^4.17.2",
@@ -80,7 +80,7 @@
 		"get-port": "^5.0.0",
 		"keyv": "^4.0.0",
 		"lolex": "^6.0.0",
-		"nock": "^11.8.2",
+		"nock": "^12.0.0",
 		"np": "^6.0.0",
 		"nyc": "^15.0.0",
 		"proxyquire": "^2.0.1",

package/readme.md

@@ -188,7 +188,7 @@ Type: `string | Buffer | stream.Readable` or [`form-data` instance](https://gith
 
 **Note #2:** If you provide this option, `got.stream()` will be read-only.
 
-**Note #3:** If you provide a payload with the `GET` or `HEAD` method, it will throw a `TypeError`.
+**Note #3:** If you provide a payload with the `GET` or `HEAD` method, it will throw a `TypeError` unless the method is `GET` and the `allowGetBody` option is set to `true`.
 
 The `content-length` header will be automatically set if `body` is a `string` / `Buffer` / `fs.createReadStream` instance / [`form-data` instance](https://github.com/form-data/form-data), and `content-length` and `transfer-encoding` are not manually set in `options.headers`.
 
@@ -410,6 +410,15 @@ Default: `true`
 
 By default, redirects will use [method rewriting](https://tools.ietf.org/html/rfc7231#section-6.4). For example, when sending a POST request and receiving a `302`, it will resend the body to the new location using the same HTTP method (`POST` in this case).
 
+###### allowGetBody
+
+Type: `boolean`\
+Default: `false`
+
+**Note:** The [RFC 7321](https://tools.ietf.org/html/rfc7231#section-4.3.1) doesn't specify any particular behavior for the GET method having a payload, therefore **it's considered an [anti-pattern](https://en.wikipedia.org/wiki/Anti-pattern)**.
+
+Set this to `true` to allow sending body for the `GET` method. However, the [HTTP/2 specification](https://tools.ietf.org/html/rfc7540#section-8.1.3) says that `An HTTP GET request includes request header fields and no payload body`, therefore when using the HTTP/2 protocol this option will have no effect. This option is only meant to interact with non-compliant servers when you have no other choice.
+
 ###### maxRedirects
 
 Type: `number`\