axios 1.0.0-alpha.1 → 1.0.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Changelog
 
-## [1.0.0] - 2022-05-30
+## [1.0.0] - 2022-10-04
 
 ### Added
 
@@ -28,6 +28,10 @@
 - Adding types for progress event callbacks [#4675](https://github.com/axios/axios/pull/4675)
 - URL params serializer [#4734](https://github.com/axios/axios/pull/4734)
 - Added axios.formToJSON method [#4735](https://github.com/axios/axios/pull/4735)
+- Bower platform add data protocol [#4804](https://github.com/axios/axios/pull/4804)
+- Use WHATWG URL API instead of url.parse() [#4852](https://github.com/axios/axios/pull/4852)
+- Add ENUM containing Http Status Codes to typings [#4903](https://github.com/axios/axios/pull/4903)
+- Improve typing of timeout in index.d.ts [#4934](https://github.com/axios/axios/pull/4934)
 
 ### Changed
 
@@ -43,8 +47,11 @@
 - Updated type definition for axios instance methods [#4224](https://github.com/axios/axios/pull/4224)
 - Updated eslint config [#4722](https://github.com/axios/axios/pull/4722)
 - Updated Docs [#4742](https://github.com/axios/axios/pull/4742)
+- Refactored Axios to use ES2017 [#4787](https://github.com/axios/axios/pull/4787)
+
 
 ### Deprecated
+- There are multiple deprecations, refactors and fixes provided in this release. Please read through the full release notes to see how this may impact your project and use case.
 
 ### Removed
 
@@ -77,6 +84,30 @@
 - Bump grunt from 1.5.2 to 1.5.3 [#4743](https://github.com/axios/axios/pull/4743)
 - Fixing content-type header repeated [#4745](https://github.com/axios/axios/pull/4745)
 - Fixed timeout error message for http [4738](https://github.com/axios/axios/pull/4738)
+- Request ignores false, 0 and empty string as body values [#4785](https://github.com/axios/axios/pull/4785)
+- Added back missing minified builds [#4805](https://github.com/axios/axios/pull/4805)
+- Fixed a type error [#4815](https://github.com/axios/axios/pull/4815)
+- Fixed a regression bug with unsubscribing from cancel token; [#4819](https://github.com/axios/axios/pull/4819)
+- Remove repeated compression algorithm [#4820](https://github.com/axios/axios/pull/4820)
+- The error of calling extend to pass parameters [#4857](https://github.com/axios/axios/pull/4857)
+- SerializerOptions.indexes allows boolean | null | undefined [#4862](https://github.com/axios/axios/pull/4862)
+- Require interceptors to return values [#4874](https://github.com/axios/axios/pull/4874)
+- Removed unused imports [#4949](https://github.com/axios/axios/pull/4949)
+- Allow null indexes on formSerializer and paramsSerializer [#4960](https://github.com/axios/axios/pull/4960)
+
+### Chores
+- Set permissions for GitHub actions [#4765](https://github.com/axios/axios/pull/4765)
+- Included githubactions in the dependabot config [#4770](https://github.com/axios/axios/pull/4770)
+- Included dependency review [#4771](https://github.com/axios/axios/pull/4771)
+- Update security.md [#4784](https://github.com/axios/axios/pull/4784)
+- Remove unnecessary spaces [#4854](https://github.com/axios/axios/pull/4854)
+- Simplify the import path of AxiosError [#4875](https://github.com/axios/axios/pull/4875)
+- Fix Gitpod dead link [#4941](https://github.com/axios/axios/pull/4941)
+- Enable syntax highlighting for a code block [#4970](https://github.com/axios/axios/pull/4970)
+- Using Logo Axios in Readme.md [#4993](https://github.com/axios/axios/pull/4993)
+- Fix markup for note in README [#4825](https://github.com/axios/axios/pull/4825)
+- Fix typo and formatting, add colons [#4853](https://github.com/axios/axios/pull/4853)
+- Fix typo in readme [#4942](https://github.com/axios/axios/pull/4942)
 
 ### Security
 
@@ -125,3 +156,26 @@
 - [chenjigeng](https://github.com/chenjigeng)
 - [João Gabriel Quaresma](https://github.com/joaoGabriel55)
 - [Victor Augusto](https://github.com/VictorAugDB)
+- [neilnaveen](https://github.com/neilnaveen)
+- [Pavlos](https://github.com/psmoros)
+- [Kiryl Valkovich](https://github.com/visortelle)
+- [Naveen](https://github.com/naveensrinivasan)
+- [wenzheng](https://github.com/0x30)
+- [hcwhan](https://github.com/hcwhan)
+- [Bassel Rachid](https://github.com/basselworkforce)
+- [Grégoire Pineau](https://github.com/lyrixx)
+- [felipedamin](https://github.com/felipedamin)
+- [Karl Horky](https://github.com/karlhorky)
+- [Yue JIN](https://github.com/kingyue737)
+- [Usman Ali Siddiqui](https://github.com/usman250994)
+- [WD](https://github.com/techbirds)
+- [Günther Foidl](https://github.com/gfoidl)
+- [Stephen Jennings](https://github.com/jennings)
+- [C.T.Lin](https://github.com/chentsulin)
+- [mia-z](https://github.com/mia-z)
+- [Parth Banathia](https://github.com/Parth0105)
+- [parth0105pluang](https://github.com/parth0105pluang)
+- [Marco Weber](https://github.com/mrcwbr)
+- [Luca Pizzini](https://github.com/lpizzinidev)
+- [Willian Agostini](https://github.com/WillianAgostini)
+- [Huyen Nguyen](https://github.com/huyenltnguyen)

package/README.md

@@ -1,9 +1,22 @@
-# axios
+<h1 align="center">
+   <b>
+        <a href="https://axios-http.com"><img src="https://axios-http.com/assets/logo.svg" /></a><br>
+    </b>
+</h1>
+
+<p align="center">Promise based HTTP client for the browser and node.js</p>
+
+<p align="center">
+    <a href="https://axios-http.com/"><b>Website</b></a> •
+    <a href="https://axios-http.com/docs/intro"><b>Documentation</b></a>
+</p> 
+
+<div align="center">
 
 [![npm version](https://img.shields.io/npm/v/axios.svg?style=flat-square)](https://www.npmjs.org/package/axios)
 [![CDNJS](https://img.shields.io/cdnjs/v/axios.svg?style=flat-square)](https://cdnjs.com/libraries/axios)
 ![Build status](https://github.com/axios/axios/actions/workflows/ci.yml/badge.svg)
-[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/axios/axios) 
+[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/axios/axios)
 [![code coverage](https://img.shields.io/coveralls/mzabriskie/axios.svg?style=flat-square)](https://coveralls.io/r/mzabriskie/axios)
 [![install size](https://packagephobia.now.sh/badge?p=axios)](https://packagephobia.now.sh/result?p=axios)
 [![npm downloads](https://img.shields.io/npm/dm/axios.svg?style=flat-square)](https://npm-stat.com/charts.html?package=axios)
@@ -12,10 +25,8 @@
 [![Known Vulnerabilities](https://snyk.io/test/npm/axios/badge.svg)](https://snyk.io/test/npm/axios)
 ![npm bundle size](https://img.shields.io/bundlephobia/minzip/axios)
 
-Promise based HTTP client for the browser and node.js
-
-> New axios docs website: [click here](https://axios-http.com/)
-
+</div>
+  
 ## Table of Contents
 
   - [Features](#features)
@@ -42,12 +53,12 @@ Promise based HTTP client for the browser and node.js
   - [Using application/x-www-form-urlencoded format](#using-applicationx-www-form-urlencoded-format)
     - [URLSearchParams](#urlsearchparams)
     - [Query string](#query-string-older-browsers)
-    - [🆕 Automatic serialization](#-automatic-serialization-to-urlsearchparams)        
-  - [Using multipart/form-data format](#using-multipartform-data-format)    
+    - [🆕 Automatic serialization](#-automatic-serialization-to-urlsearchparams)
+  - [Using multipart/form-data format](#using-multipartform-data-format)
     - [FormData](#formdata)
-    - [🆕 Automatic serialization](#-automatic-serialization-to-formdata) 
+    - [🆕 Automatic serialization](#-automatic-serialization-to-formdata)
   - [Files Posting](#files-posting)
-  - [HTML Form Posting](#html-form-posting-browser)
+  - [HTML Form Posting](#-html-form-posting-browser)
   - [Semver](#semver)
   - [Promises](#promises)
   - [TypeScript](#typescript)
@@ -139,7 +150,7 @@ axios.get('/user?ID=12345')
     // handle error
     console.log(error);
   })
-  .then(function () {
+  .finally(function () {
     // always executed
   });
 
@@ -155,9 +166,9 @@ axios.get('/user', {
   .catch(function (error) {
     console.log(error);
   })
-  .then(function () {
+  .finally(function () {
     // always executed
-  });  
+  });
 
 // Want to use async/await? Add the `async` keyword to your outer function/method.
 async function getUser() {
@@ -170,7 +181,7 @@ async function getUser() {
 }
 ```
 
-> **NOTE:** `async/await` is part of ECMAScript 2017 and is not supported in Internet
+> **Note** `async/await` is part of ECMAScript 2017 and is not supported in Internet
 > Explorer and older browsers, so use with caution.
 
 Performing a `POST` request
@@ -354,7 +365,7 @@ These are the available config options for making requests. Only the `url` is re
   data: {
     firstName: 'Fred'
   },
-  
+
   // syntax alternative to send data into the body
   // method post
   // only the value is sent, not the key
@@ -462,7 +473,7 @@ These are the available config options for making requests. Only the `url` is re
   // supplies credentials.
   // This will set an `Proxy-Authorization` header, overwriting any existing
   // `Proxy-Authorization` custom headers you have set using `headers`.
-  // If the proxy server uses HTTPS, then you must set the protocol to `https`. 
+  // If the proxy server uses HTTPS, then you must set the protocol to `https`.
   proxy: {
     protocol: 'https',
     host: '127.0.0.1',
@@ -481,8 +492,8 @@ These are the available config options for making requests. Only the `url` is re
   // an alternative way to cancel Axios requests using AbortController
   signal: new AbortController().signal,
 
-  // `decompress` indicates whether or not the response body should be decompressed 
-  // automatically. If set to `true` will also remove the 'content-encoding' header 
+  // `decompress` indicates whether or not the response body should be decompressed
+  // automatically. If set to `true` will also remove the 'content-encoding' header
   // from the responses objects of all decompressed responses
   // - Node only (XHR cannot turn off decompression)
   decompress: true // default
@@ -504,7 +515,7 @@ These are the available config options for making requests. Only the `url` is re
 
     // try to parse the response string as JSON even if `responseType` is not 'json'
     forcedJSONParsing: true,
-    
+
     // throw ETIMEDOUT error instead of generic ECONNABORTED on request timeouts
     clarifyTimeoutError: false,
   },
@@ -515,9 +526,9 @@ These are the available config options for making requests. Only the `url` is re
   },
 
   formSerializer: {
-      visitor: (value, key, path, helpers)=> {}; // custom visitor funaction to serrialize form values
+      visitor: (value, key, path, helpers) => {}; // custom visitor funaction to serrialize form values
       dots: boolean; // use dots instead of brackets format
-      metaTokens: boolean; // keep special endings like {} in parameter key 
+      metaTokens: boolean; // keep special endings like {} in parameter key
       indexes: boolean; // array indexes format null - no brackets, false - empty brackets, true - brackets with indexes
   }
 }
@@ -665,7 +676,7 @@ instance.interceptors.request.use(function () {/*...*/});
 ```
 
 When you add request interceptors, they are presumed to be asynchronous by default. This can cause a delay
-in the execution of your axios request when the main thread is blocked (a promise is created under the hood for 
+in the execution of your axios request when the main thread is blocked (a promise is created under the hood for
 the interceptor and your request gets put on the bottom of the call stack). If your request interceptors are synchronous you can add a flag
 to the options object that will tell axios to run the code synchronously and avoid any delays in request execution.
 
@@ -676,7 +687,7 @@ axios.interceptors.request.use(function (config) {
 }, null, { synchronous: true });
 ```
 
-If you want to execute a particular interceptor based on a runtime check, 
+If you want to execute a particular interceptor based on a runtime check,
 you can add a `runWhen` function to the options object. The interceptor will not be executed **if and only if** the return
 of `runWhen` is `false`. The function will be called with the config
 object (don't forget that you can bind your own arguments to it as well.) This can be handy when you have an
@@ -704,7 +715,7 @@ and when the response was fulfilled
     - then the following fulfillment-interceptor is not called
     - then the following rejection-interceptor is called
     - once caught, another following fulfill-interceptor is called again (just like in a promise chain).
-    
+
 Read [the interceptor tests](./test/specs/interceptors.spec.js) for seeing all this in code.
 
 ## Handling Errors
@@ -819,7 +830,7 @@ axios.get('/user/12345', {
 cancel();
 ```
 
-> Note: you can cancel several requests with the same cancel token/abort controller.
+> **Note:** you can cancel several requests with the same cancel token/abort controller.
 > If a cancellation token is already cancelled at the moment of starting an Axios request, then the request is cancelled immediately, without any attempts to make a real request.
 
 > During the transition period, you can use both cancellation APIs, even for the same request:
@@ -872,14 +883,14 @@ axios.post('https://something.com/', querystring.stringify({ foo: 'bar' }));
 
 You can also use the [`qs`](https://github.com/ljharb/qs) library.
 
-> NOTE: 
+> **Note**
 > The `qs` library is preferable if you need to stringify nested objects, as the `querystring` method has [known issues](https://github.com/nodejs/node-v0.x-archive/issues/1665) with that use case.
 
 ### 🆕 Automatic serialization to URLSearchParams
 
 Axios will automatically serialize the data object to urlencoded format if the content-type header is set to "application/x-www-form-urlencoded".
 
-```
+```js
 const data = {
   x: 1,
   arr: [1, 2, 3],
@@ -892,7 +903,7 @@ await axios.postForm('https://postman-echo.com/post', data,
 );
 ```
 
-The server will handle it as 
+The server will handle it as
 
 ```js
   {
@@ -913,9 +924,9 @@ If your backend body-parser (like `body-parser` of `express.js`) supports nested
 
 ```js
   var app = express();
-  
+
   app.use(bodyParser.urlencoded({ extended: true })); // support encoded bodies
-  
+
   app.post('/', function (req, res, next) {
      // echo body as JSON
      res.send(JSON.stringify(req.body));
@@ -928,7 +939,7 @@ If your backend body-parser (like `body-parser` of `express.js`) supports nested
 
 ### FormData
 
-To send the data as a `multipart/formdata` you need to pass a formData instance as a payload. 
+To send the data as a `multipart/formdata` you need to pass a formData instance as a payload.
 Setting the `Content-Type` header is not required as Axios guesses it based on the payload type.
 
 ```js
@@ -937,12 +948,12 @@ formData.append('foo', 'bar');
 
 axios.post('https://httpbin.org/post', formData);
 ```
-  
+
 In node.js, you can use the [`form-data`](https://github.com/form-data/form-data) library as follows:
 
 ```js
 const FormData = require('form-data');
- 
+
 const form = new FormData();
 form.append('my_field', 'my value');
 form.append('my_buffer', new Buffer(10));
@@ -953,7 +964,7 @@ axios.post('https://example.com', form)
 
 ### 🆕 Automatic serialization to FormData
 
-Starting from `v0.27.0`, Axios supports automatic object serialization to a FormData object if the request `Content-Type` 
+Starting from `v0.27.0`, Axios supports automatic object serialization to a FormData object if the request `Content-Type`
 header is set to `multipart/form-data`.
 
 The following request will submit the data in a FormData format (Browser & Node.js):
@@ -965,7 +976,7 @@ axios.post('https://httpbin.org/post', {x: 1}, {
   headers: {
     'Content-Type': 'multipart/form-data'
   }
-}).then(({data})=> console.log(data));
+}).then(({data}) => console.log(data));
 ```
 
 In the `node.js` build, the ([`form-data`](https://github.com/form-data/form-data)) polyfill is used by default.
@@ -974,22 +985,22 @@ You can overload the FormData class by setting the `env.FormData` config variabl
 but you probably won't need it in most cases:
 
 ```js
-const axios= require('axios');
+const axios = require('axios');
 var FormData = require('form-data');
 
 axios.post('https://httpbin.org/post', {x: 1, buf: new Buffer(10)}, {
   headers: {
     'Content-Type': 'multipart/form-data'
   }
-}).then(({data})=> console.log(data));
+}).then(({data}) => console.log(data));
 ```
 
 Axios FormData serializer supports some special endings to perform the following operations:
 
 - `{}` - serialize the value with JSON.stringify
-- `[]` - unwrap the array-like object as separate fields with the same key 
+- `[]` - unwrap the array-like object as separate fields with the same key
 
-> NOTE: 
+> **Note**
 > unwrap/expand operation will be used by default on arrays and FileList objects
 
 FormData serializer supports additional options via `config.formSerializer: object` property to handle rare cases:
@@ -999,15 +1010,15 @@ to a `FormData` object by following custom rules.
 
 - `dots: boolean = false` - use dot notation instead of brackets to serialize arrays and objects;
 
-- `metaTokens: boolean = true` - add the special ending (e.g `user{}: '{"name": "John"}'`) in the FormData key. 
+- `metaTokens: boolean = true` - add the special ending (e.g `user{}: '{"name": "John"}'`) in the FormData key.
 The back-end body-parser could potentially use this meta-information to automatically parse the value as JSON.
 
 - `indexes: null|false|true = false` - controls how indexes will be added to unwrapped keys of `flat` array-like objects
 
-    - `null` - don't add brackets (`arr: 1`, `arr: 2`, `arr: 3`) 
+    - `null` - don't add brackets (`arr: 1`, `arr: 2`, `arr: 3`)
     - `false`(default) - add empty brackets (`arr[]: 1`, `arr[]: 2`, `arr[]: 3`)
     - `true` - add brackets with indexes  (`arr[0]: 1`, `arr[1]: 2`, `arr[2]: 3`)
-    
+
 Let's say we have an object like this one:
 
 ```js
@@ -1023,7 +1034,7 @@ const obj = {
 The following steps will be executed by the Axios serializer internally:
 
 ```js
-const formData= new FormData();
+const formData = new FormData();
 formData.append('x', '1');
 formData.append('arr[]', '1');
 formData.append('arr[]', '2');
@@ -1043,20 +1054,20 @@ which are just the corresponding http methods with the `Content-Type` header pre
 
 ## Files Posting
 
-You can easily sumbit a single file
+You can easily submit a single file:
 
 ```js
 await axios.postForm('https://httpbin.org/post', {
   'myVar' : 'foo',
-  'file': document.querySelector('#fileInput').files[0] 
+  'file': document.querySelector('#fileInput').files[0]
 });
 ```
 
-or multiple files as `multipart/form-data`.
+or multiple files as `multipart/form-data`:
 
 ```js
 await axios.postForm('https://httpbin.org/post', {
-  'files[]': document.querySelector('#fileInput').files 
+  'files[]': document.querySelector('#fileInput').files
 });
 ```
 
@@ -1159,7 +1170,7 @@ try {
 
 You can use Gitpod, an online IDE(which is free for Open Source) for contributing or running the examples online.
 
-[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/axios/axios/blob/master/examples/server.js)
+[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/axios/axios/blob/main/examples/server.js)
 
 
 ## Resources

package/SECURITY.md

@@ -1,5 +1,6 @@
 # Reporting a Vulnerability
 
-If you discover a security vulnerability within axios, please submit a report via [huntr.dev](https://huntr.dev/bounties/?target=https%3A%2F%2Fgithub.com%2Faxios%2Faxios). Bounties and CVEs are automatically managed and allocated via the platform.
+If you discover a security vulnerability in axios please disclose it via [our huntr page](https://huntr.dev/repos/axios/axios/). Bounty eligibility, CVE assignment, response times and past reports are all there.
 
-All security vulnerabilities will be promptly addressed.
+
+Thank you for improving the security of axios.

package/bin/ssl_hotfix.js

@@ -1,4 +1,4 @@
-const {spawn} = require('child_process');
+import {spawn} from 'child_process';
 
 const args = process.argv.slice(2);