axios 1.0.0-alpha.1 → 1.0.0

package/index.d.ts

@@ -1,5 +1,6 @@
 // TypeScript Version: 4.1
-type AxiosHeaders = Record<string, string | string[] | number | boolean>;
+type AxiosHeaderValue = string | string[] | number | boolean | null;
+type RawAxiosHeaders = Record<string, AxiosHeaderValue>;
 
 type MethodsHeaders = {
   [Key in Method as Lowercase<Key>]: AxiosHeaders;
@@ -9,18 +10,78 @@ interface CommonHeaders  {
   common: AxiosHeaders;
 }
 
-export type AxiosRequestHeaders = Partial<AxiosHeaders & MethodsHeaders & CommonHeaders>;
+type AxiosHeaderMatcher = (this: AxiosHeaders, value: string, name: string, headers: RawAxiosHeaders) => boolean;
 
-export type AxiosResponseHeaders = Record<string, string> & {
+type AxiosHeaderSetter = (value: AxiosHeaderValue, rewrite?: boolean | AxiosHeaderMatcher) => AxiosHeaders;
+
+type AxiosHeaderGetter = ((parser?: RegExp) => RegExpExecArray | null) |
+    ((matcher?: AxiosHeaderMatcher) => AxiosHeaderValue);
+
+type AxiosHeaderTester = (matcher?: AxiosHeaderMatcher) => boolean;
+
+export class AxiosHeaders {
+  constructor(
+      headers?: RawAxiosHeaders | AxiosHeaders,
+      defaultHeaders?: RawAxiosHeaders | AxiosHeaders
+  );
+
+  set(headerName?: string, value?: AxiosHeaderValue, rewrite?: boolean | AxiosHeaderMatcher): AxiosHeaders;
+  set(headers?: RawAxiosHeaders | AxiosHeaders, rewrite?: boolean): AxiosHeaders;
+
+  get(headerName: string, parser: RegExp): RegExpExecArray | null;
+  get(headerName: string, matcher?: true | AxiosHeaderMatcher): AxiosHeaderValue;
+
+  has(header: string, matcher?: true | AxiosHeaderMatcher): boolean;
+
+  delete(header: string | string[], matcher?: AxiosHeaderMatcher): boolean;
+
+  clear(): boolean;
+
+  normalize(format: boolean): AxiosHeaders;
+
+  toJSON(): RawAxiosHeaders;
+
+  static from(thing?: AxiosHeaders | RawAxiosHeaders | string): AxiosHeaders;
+
+  static accessor(header: string | string[]): AxiosHeaders;
+
+  setContentType: AxiosHeaderSetter;
+  getContentType: AxiosHeaderGetter;
+  hasContentType: AxiosHeaderTester;
+
+  setContentLength: AxiosHeaderSetter;
+  getContentLength: AxiosHeaderGetter;
+  hasContentLength: AxiosHeaderTester;
+
+  setAccept: AxiosHeaderSetter;
+  getAccept: AxiosHeaderGetter;
+  hasAccept: AxiosHeaderTester;
+
+  setUserAgent: AxiosHeaderSetter;
+  getUserAgent: AxiosHeaderGetter;
+  hasUserAgent: AxiosHeaderTester;
+
+  setContentEncoding: AxiosHeaderSetter;
+  getContentEncoding: AxiosHeaderGetter;
+  hasContentEncoding: AxiosHeaderTester;
+}
+
+export type RawAxiosRequestHeaders = Partial<RawAxiosHeaders & MethodsHeaders & CommonHeaders>;
+
+export type AxiosRequestHeaders = Partial<RawAxiosHeaders & MethodsHeaders & CommonHeaders> & AxiosHeaders;
+
+export type RawAxiosResponseHeaders = Partial<Record<string, string> & {
   "set-cookie"?: string[]
-};
+}>;
+
+export type AxiosResponseHeaders = RawAxiosResponseHeaders & AxiosHeaders;
 
 export interface AxiosRequestTransformer {
-  (data: any, headers: AxiosRequestHeaders): any;
+  (this: AxiosRequestConfig, data: any, headers: AxiosRequestHeaders): any;
 }
 
 export interface AxiosResponseTransformer {
-  (data: any, headers?: AxiosResponseHeaders, status?: number): any;
+  (this: AxiosRequestConfig, data: any, headers: AxiosResponseHeaders, status?: number): any;
 }
 
 export interface AxiosAdapter {
@@ -42,39 +103,105 @@ export interface AxiosProxyConfig {
   protocol?: string;
 }
 
+export enum HttpStatusCode {
+  Continue = 100,
+  SwitchingProtocols = 101,
+  Processing = 102,
+  EarlyHints = 103,
+  Ok = 200,
+  Created = 201,
+  Accepted = 202,
+  NonAuthoritativeInformation = 203,
+  NoContent = 204,
+  ResetContent = 205,
+  PartialContent = 206,
+  MultiStatus = 207,
+  AlreadyReported = 208,
+  ImUsed = 226,
+  MultipleChoices = 300,
+  MovedPermanently = 301,
+  Found = 302,
+  SeeOther = 303,
+  NotModified = 304,
+  UseProxy = 305,
+  Unused = 306,
+  TemporaryRedirect = 307,
+  PermanentRedirect = 308,
+  BadRequest = 400,
+  Unauthorized = 401,
+  PaymentRequired = 402,
+  Forbidden = 403,
+  NotFound = 404,
+  MethodNotAllowed = 405,
+  NotAcceptable = 406,
+  ProxyAuthenticationRequired = 407,
+  RequestTimeout = 408,
+  Conflict = 409,
+  Gone = 410,
+  LengthRequired = 411,
+  PreconditionFailed = 412,
+  PayloadTooLarge = 413,
+  UriTooLong = 414,
+  UnsupportedMediaType = 415,
+  RangeNotSatisfiable = 416,
+  ExpectationFailed = 417,
+  ImATeapot = 418,
+  MisdirectedRequest = 421,
+  UnprocessableEntity = 422,
+  Locked = 423,
+  FailedDependency = 424,
+  TooEarly = 425,
+  UpgradeRequired = 426,
+  PreconditionRequired = 428,
+  TooManyRequests = 429,
+  RequestHeaderFieldsTooLarge = 431,
+  UnavailableForLegalReasons = 451,
+  InternalServerError = 500,
+  NotImplemented = 501,
+  BadGateway = 502,
+  ServiceUnavailable = 503,
+  GatewayTimeout = 504,
+  HttpVersionNotSupported = 505,
+  VariantAlsoNegotiates = 506,
+  InsufficientStorage = 507,
+  LoopDetected = 508,
+  NotExtended = 510,
+  NetworkAuthenticationRequired = 511,
+}
+
 export type Method =
-  | 'get' | 'GET'
-  | 'delete' | 'DELETE'
-  | 'head' | 'HEAD'
-  | 'options' | 'OPTIONS'
-  | 'post' | 'POST'
-  | 'put' | 'PUT'
-  | 'patch' | 'PATCH'
-  | 'purge' | 'PURGE'
-  | 'link' | 'LINK'
-  | 'unlink' | 'UNLINK';
+    | 'get' | 'GET'
+    | 'delete' | 'DELETE'
+    | 'head' | 'HEAD'
+    | 'options' | 'OPTIONS'
+    | 'post' | 'POST'
+    | 'put' | 'PUT'
+    | 'patch' | 'PATCH'
+    | 'purge' | 'PURGE'
+    | 'link' | 'LINK'
+    | 'unlink' | 'UNLINK';
 
 export type ResponseType =
-  | 'arraybuffer'
-  | 'blob'
-  | 'document'
-  | 'json'
-  | 'text'
-  | 'stream';
-
-  export type responseEncoding =
-  | 'ascii' | 'ASCII'
-  | 'ansi' | 'ANSI'
-  | 'binary' | 'BINARY'
-  | 'base64' | 'BASE64'
-  | 'base64url' | 'BASE64URL'
-  | 'hex' | 'HEX'
-  | 'latin1' | 'LATIN1'
-  | 'ucs-2' | 'UCS-2'
-  | 'ucs2' | 'UCS2'
-  | 'utf-8' | 'UTF-8'
-  | 'utf8' | 'UTF8'
-  | 'utf16le' | 'UTF16LE';
+    | 'arraybuffer'
+    | 'blob'
+    | 'document'
+    | 'json'
+    | 'text'
+    | 'stream';
+
+export type responseEncoding =
+    | 'ascii' | 'ASCII'
+    | 'ansi' | 'ANSI'
+    | 'binary' | 'BINARY'
+    | 'base64' | 'BASE64'
+    | 'base64url' | 'BASE64URL'
+    | 'hex' | 'HEX'
+    | 'latin1' | 'LATIN1'
+    | 'ucs-2' | 'UCS-2'
+    | 'ucs2' | 'UCS2'
+    | 'utf-8' | 'UTF-8'
+    | 'utf8' | 'UTF8'
+    | 'utf16le' | 'UTF16LE';
 
 export interface TransitionalOptions {
   silentJSONParsing?: boolean;
@@ -109,7 +236,7 @@ export interface SerializerOptions {
   visitor?: SerializerVisitor;
   dots?: boolean;
   metaTokens?: boolean;
-  indexes?: boolean;
+  indexes?: boolean | null;
 }
 
 // tslint:disable-next-line
@@ -124,17 +251,34 @@ export interface ParamsSerializerOptions extends SerializerOptions {
   encode?: ParamEncoder;
 }
 
+type MaxUploadRate = number;
+
+type MaxDownloadRate = number;
+
+export interface AxiosProgressEvent {
+  loaded: number;
+  total?: number;
+  progress?: number;
+  bytes: number;
+  rate?: number;
+  estimated?: number;
+  upload?: boolean;
+  download?: boolean;
+}
+
+type Milliseconds = number;
+
 export interface AxiosRequestConfig<D = any> {
   url?: string;
   method?: Method | string;
   baseURL?: string;
   transformRequest?: AxiosRequestTransformer | AxiosRequestTransformer[];
   transformResponse?: AxiosResponseTransformer | AxiosResponseTransformer[];
-  headers?: AxiosRequestHeaders;
+  headers?: RawAxiosRequestHeaders;
   params?: any;
   paramsSerializer?: ParamsSerializerOptions;
   data?: D;
-  timeout?: number;
+  timeout?: Milliseconds;
   timeoutErrorMessage?: string;
   withCredentials?: boolean;
   adapter?: AxiosAdapter;
@@ -143,12 +287,13 @@ export interface AxiosRequestConfig<D = any> {
   responseEncoding?: responseEncoding | string;
   xsrfCookieName?: string;
   xsrfHeaderName?: string;
-  onUploadProgress?: (progressEvent: ProgressEvent) => void;
-  onDownloadProgress?: (progressEvent: ProgressEvent) => void;
+  onUploadProgress?: (progressEvent: AxiosProgressEvent) => void;
+  onDownloadProgress?: (progressEvent: AxiosProgressEvent) => void;
   maxContentLength?: number;
   validateStatus?: ((status: number) => boolean) | null;
   maxBodyLength?: number;
   maxRedirects?: number;
+  maxRate?: number | [MaxUploadRate, MaxDownloadRate];
   beforeRedirect?: (options: Record<string, any>, responseDetails: {headers: Record<string, string>}) => void;
   socketPath?: string | null;
   httpAgent?: any;
@@ -166,17 +311,17 @@ export interface AxiosRequestConfig<D = any> {
 }
 
 export interface HeadersDefaults {
-  common: AxiosRequestHeaders;
-  delete: AxiosRequestHeaders;
-  get: AxiosRequestHeaders;
-  head: AxiosRequestHeaders;
-  post: AxiosRequestHeaders;
-  put: AxiosRequestHeaders;
-  patch: AxiosRequestHeaders;
-  options?: AxiosRequestHeaders;
-  purge?: AxiosRequestHeaders;
-  link?: AxiosRequestHeaders;
-  unlink?: AxiosRequestHeaders;
+  common: RawAxiosRequestHeaders;
+  delete: RawAxiosRequestHeaders;
+  get: RawAxiosRequestHeaders;
+  head: RawAxiosRequestHeaders;
+  post: RawAxiosRequestHeaders;
+  put: RawAxiosRequestHeaders;
+  patch: RawAxiosRequestHeaders;
+  options?: RawAxiosRequestHeaders;
+  purge?: RawAxiosRequestHeaders;
+  link?: RawAxiosRequestHeaders;
+  unlink?: RawAxiosRequestHeaders;
 }
 
 export interface AxiosDefaults<D = any> extends Omit<AxiosRequestConfig<D>, 'headers'> {
@@ -184,25 +329,25 @@ export interface AxiosDefaults<D = any> extends Omit<AxiosRequestConfig<D>, 'hea
 }
 
 export interface CreateAxiosDefaults<D = any> extends Omit<AxiosRequestConfig<D>, 'headers'> {
-  headers?: AxiosRequestHeaders | Partial<HeadersDefaults>;
+  headers?: RawAxiosRequestHeaders | Partial<HeadersDefaults>;
 }
 
 export interface AxiosResponse<T = any, D = any>  {
   data: T;
   status: number;
   statusText: string;
-  headers: AxiosResponseHeaders;
+  headers: RawAxiosResponseHeaders | AxiosResponseHeaders;
   config: AxiosRequestConfig<D>;
   request?: any;
 }
 
 export class AxiosError<T = unknown, D = any> extends Error {
   constructor(
-    message?: string,
-    code?: string,
-    config?: AxiosRequestConfig<D>,
-    request?: any,
-    response?: AxiosResponse<T, D>
+      message?: string,
+      code?: string,
+      config?: AxiosRequestConfig<D>,
+      request?: any,
+      response?: AxiosResponse<T, D>
   );
 
   config?: AxiosRequestConfig<D>;
@@ -266,7 +411,7 @@ export interface AxiosInterceptorOptions {
 }
 
 export interface AxiosInterceptorManager<V> {
-  use<T = V>(onFulfilled?: (value: V) => T | Promise<T>, onRejected?: (error: any) => any, options?: AxiosInterceptorOptions): number;
+  use(onFulfilled?: (value: V) => V | Promise<V>, onRejected?: (error: any) => any, options?: AxiosInterceptorOptions): number;
   eject(id: number): void;
 }
 
@@ -292,12 +437,12 @@ export class Axios {
 }
 
 export interface AxiosInstance extends Axios {
-  <T = any, R = AxiosResponse<T>, D = any>(config: AxiosRequestConfig<D>): AxiosPromise<R>;
-  <T = any, R = AxiosResponse<T>, D = any>(url: string, config?: AxiosRequestConfig<D>): AxiosPromise<R>;
+  <T = any, R = AxiosResponse<T>, D = any>(config: AxiosRequestConfig<D>): Promise<R>;
+  <T = any, R = AxiosResponse<T>, D = any>(url: string, config?: AxiosRequestConfig<D>): Promise<R>;
 
   defaults: Omit<AxiosDefaults, 'headers'> & {
     headers: HeadersDefaults & {
-      [key: string]: string | number | boolean | undefined
+      [key: string]: AxiosHeaderValue
     }
   };
 }

package/index.js

@@ -1 +1,2 @@
-module.exports = require('./lib/axios');
+import axios from './lib/axios.js';
+export default axios;

package/karma.conf.cjs

@@ -0,0 +1,250 @@
+/* eslint-disable no-console */
+/* eslint-disable no-unused-vars */
+/* eslint-disable func-names */
+// Karma configuration
+// Generated on Fri Aug 15 2014 23:11:13 GMT-0500 (CDT)
+
+'use strict';
+
+var resolve = require('@rollup/plugin-node-resolve').default;
+var commonjs = require('@rollup/plugin-commonjs');
+
+function createCustomLauncher(browser, version, platform) {
+  return {
+    base: 'SauceLabs',
+    browserName: browser,
+    version: version,
+    platform: platform
+  };
+}
+
+module.exports = function(config) {
+  var customLaunchers = {};
+  var browsers = process.env.Browsers && process.env.Browsers.split(',');
+  var sauceLabs;
+
+  if (process.env.SAUCE_USERNAME || process.env.SAUCE_ACCESS_KEY) {
+    customLaunchers = {};
+
+    var runAll = true;
+    var options = [
+      'SAUCE_CHROME',
+      'SAUCE_FIREFOX',
+      'SAUCE_SAFARI',
+      'SAUCE_OPERA',
+      'SAUCE_IE',
+      'SAUCE_EDGE',
+      'SAUCE_IOS',
+      'SAUCE_ANDROID'
+    ];
+
+    options.forEach(function(opt) {
+      if (process.env[opt]) {
+        runAll = false;
+      }
+    });
+
+    // Chrome
+    if (runAll || process.env.SAUCE_CHROME) {
+      customLaunchers.SL_Chrome = createCustomLauncher('chrome');
+      // customLaunchers.SL_ChromeDev = createCustomLauncher('chrome', 'dev');
+      // customLaunchers.SL_ChromeBeta = createCustomLauncher('chrome', 'beta');
+    }
+
+    // Firefox
+    if (runAll || process.env.SAUCE_FIREFOX) {
+      //customLaunchers.SL_Firefox = createCustomLauncher('firefox');
+      // customLaunchers.SL_FirefoxDev = createCustomLauncher('firefox', 'dev');
+      // customLaunchers.SL_FirefoxBeta = createCustomLauncher('firefox', 'beta');
+    }
+
+    // Safari
+    if (runAll || process.env.SAUCE_SAFARI) {
+      // customLaunchers.SL_Safari7 = createCustomLauncher('safari', 7);
+      // customLaunchers.SL_Safari8 = createCustomLauncher('safari', 8);
+      customLaunchers.SL_Safari9 = createCustomLauncher(
+        'safari',
+        9.0,
+        'OS X 10.11'
+      );
+      customLaunchers.SL_Safari10 = createCustomLauncher(
+        'safari',
+        '10.1',
+        'macOS 10.12'
+      );
+      customLaunchers.SL_Safari11 = createCustomLauncher(
+        'safari',
+        '11.1',
+        'macOS 10.13'
+      );
+    }
+
+    // Opera
+    if (runAll || process.env.SAUCE_OPERA) {
+      // TODO The available versions of Opera are too old and lack basic APIs
+      // customLaunchers.SL_Opera11 = createCustomLauncher('opera', 11, 'Windows XP');
+      // customLaunchers.SL_Opera12 = createCustomLauncher('opera', 12, 'Windows 7');
+    }
+
+    // IE
+    if (runAll || process.env.SAUCE_IE) {
+      customLaunchers.SL_IE11 = createCustomLauncher('internet explorer', 11, 'Windows 8.1');
+    }
+
+    // Edge
+    if (runAll || process.env.SAUCE_EDGE) {
+      customLaunchers.SL_Edge = createCustomLauncher('microsoftedge', null, 'Windows 10');
+    }
+
+    // IOS
+    if (runAll || process.env.SAUCE_IOS) {
+      // TODO IOS7 capture always timesout
+      // customLaunchers.SL_IOS7 = createCustomLauncher('iphone', '7.1', 'OS X 10.10');
+      // TODO Mobile browsers are causing failures, possibly from too many concurrent VMs
+      // customLaunchers.SL_IOS8 = createCustomLauncher('iphone', '8.4', 'OS X 10.10');
+      // customLaunchers.SL_IOS9 = createCustomLauncher('iphone', '9.2', 'OS X 10.10');
+    }
+
+    // Android
+    if (runAll || process.env.SAUCE_ANDROID) {
+      // TODO Mobile browsers are causing failures, possibly from too many concurrent VMs
+      // customLaunchers.SL_Android4 = createCustomLauncher('android', '4.4', 'Linux');
+      // customLaunchers.SL_Android5 = createCustomLauncher('android', '5.1', 'Linux');
+    }
+
+    browsers = Object.keys(customLaunchers);
+
+    sauceLabs = {
+      recordScreenshots: false,
+      connectOptions: {
+        // port: 5757,
+        logfile: 'sauce_connect.log'
+      },
+      public: 'public'
+    };
+  } else if (process.env.TRAVIS_PULL_REQUEST && process.env.TRAVIS_PULL_REQUEST !== 'false') {
+    console.log(
+      'Cannot run on Sauce Labs as encrypted environment variables are not available to PRs. ' +
+      'Running on Travis.'
+    );
+    browsers = ['Firefox'];
+  } else if (process.env.GITHUB_ACTIONS === 'true') {
+    console.log('Running ci on Github Actions.');
+    browsers = ['FirefoxHeadless', 'ChromeHeadless'];
+  } else {
+    browsers = browsers || ['Chrome'];
+    console.log(`Running ${browsers} locally since SAUCE_USERNAME and SAUCE_ACCESS_KEY environment variables are not set.`);
+  }
+
+  config.set({
+    // base path that will be used to resolve all patterns (eg. files, exclude)
+    basePath: '',
+
+
+    // frameworks to use
+    // available frameworks: https://npmjs.org/browse/keyword/karma-adapter
+    frameworks: ['jasmine-ajax', 'jasmine', 'sinon'],
+
+
+    // list of files / patterns to load in the browser
+    files: [
+      {pattern: 'test/specs/__helpers.js', watched: false},
+      {pattern: 'test/specs/**/*.spec.js', watched: false}
+    ],
+
+
+    // list of files to exclude
+    exclude: [],
+
+
+    // preprocess matching files before serving them to the browser
+    // available preprocessors: https://npmjs.org/browse/keyword/karma-preprocessor
+    preprocessors: {
+      'test/specs/__helpers.js': ['rollup'],
+      'test/specs/**/*.spec.js': ['rollup']
+    },
+
+    rollupPreprocessor: {
+      plugins: [
+        resolve({browser: true}),
+        commonjs()
+      ],
+      output: {
+        format: 'iife',
+        name: '_axios',
+        sourcemap: 'inline'
+      }
+    },
+
+
+    // test results reporter to use
+    // possible values: 'dots', 'progress'
+    // available reporters: https://npmjs.org/browse/keyword/karma-reporter
+    // Disable code coverage, as it's breaking CI:
+    // reporters: ['dots', 'coverage', 'saucelabs'],
+    reporters: ['progress'],
+
+
+    // web server port
+    port: 9876,
+
+
+    // Increase timeouts to prevent the issue with disconnected tests (https://goo.gl/nstA69)
+    captureTimeout: 4 * 60 * 1000,
+    browserDisconnectTimeout: 10000,
+    browserDisconnectTolerance: 1,
+    browserNoActivityTimeout: 4 * 60 * 1000,
+
+
+    // enable / disable colors in the output (reporters and logs)
+    colors: true,
+
+
+    // level of logging
+    // possible values: config.LOG_DISABLE || config.LOG_ERROR || config.LOG_WARN || config.LOG_INFO || config.LOG_DEBUG
+    logLevel: config.LOG_INFO,
+
+
+    // enable / disable watching file and executing tests whenever any file changes
+    autoWatch: false,
+
+
+    // start these browsers
+    // available browser launchers: https://npmjs.org/browse/keyword/karma-launcher
+    browsers: browsers,
+
+
+    // Continuous Integration mode
+    // if true, Karma captures browsers, runs the tests and exits
+    singleRun: false,
+
+    // Webpack config
+    webpack: {
+      mode: 'development',
+      cache: true,
+      devtool: 'inline-source-map',
+      externals: [
+        {
+          './adapters/http': 'var undefined'
+        }
+      ]
+    },
+
+    webpackServer: {
+      stats: {
+        colors: true
+      }
+    },
+
+
+    // Coverage reporting
+    coverageReporter: {
+      type: 'lcov',
+      dir: 'coverage/',
+      subdir: '.'
+    },
+
+    sauceLabs: sauceLabs,
+    customLaunchers: customLaunchers
+  });
+};