axios 1.0.0-alpha.1 → 1.1.0

package/lib/helpers/AxiosTransformStream.js

@@ -0,0 +1,191 @@
+'use strict';
+
+import stream from 'stream';
+import utils from '../utils.js';
+import throttle from './throttle.js';
+import speedometer from './speedometer.js';
+
+const kInternals = Symbol('internals');
+
+class AxiosTransformStream extends stream.Transform{
+  constructor(options) {
+    options = utils.toFlatObject(options, {
+      maxRate: 0,
+      chunkSize: 64 * 1024,
+      minChunkSize: 100,
+      timeWindow: 500,
+      ticksRate: 2,
+      samplesCount: 15
+    }, null, (prop, source) => {
+      return !utils.isUndefined(source[prop]);
+    });
+
+    super({
+      readableHighWaterMark: options.chunkSize
+    });
+
+    const self = this;
+
+    const internals = this[kInternals] = {
+      length: options.length,
+      timeWindow: options.timeWindow,
+      ticksRate: options.ticksRate,
+      chunkSize: options.chunkSize,
+      maxRate: options.maxRate,
+      minChunkSize: options.minChunkSize,
+      bytesSeen: 0,
+      isCaptured: false,
+      notifiedBytesLoaded: 0,
+      ts: Date.now(),
+      bytes: 0,
+      onReadCallback: null
+    };
+
+    const _speedometer = speedometer(internals.ticksRate * options.samplesCount, internals.timeWindow);
+
+    this.on('newListener', event => {
+      if (event === 'progress') {
+        if (!internals.isCaptured) {
+          internals.isCaptured = true;
+        }
+      }
+    });
+
+    let bytesNotified = 0;
+
+    internals.updateProgress = throttle(function throttledHandler() {
+      const totalBytes = internals.length;
+      const bytesTransferred = internals.bytesSeen;
+      const progressBytes = bytesTransferred - bytesNotified;
+      if (!progressBytes || self.destroyed) return;
+
+      const rate = _speedometer(progressBytes);
+
+      bytesNotified = bytesTransferred;
+
+      process.nextTick(() => {
+        self.emit('progress', {
+          'loaded': bytesTransferred,
+          'total': totalBytes,
+          'progress': totalBytes ? (bytesTransferred / totalBytes) : undefined,
+          'bytes': progressBytes,
+          'rate': rate ? rate : undefined,
+          'estimated': rate && totalBytes && bytesTransferred <= totalBytes ?
+            (totalBytes - bytesTransferred) / rate : undefined
+        });
+      });
+    }, internals.ticksRate);
+
+    const onFinish = () => {
+      internals.updateProgress(true);
+    };
+
+    this.once('end', onFinish);
+    this.once('error', onFinish);
+  }
+
+  _read(size) {
+    const internals = this[kInternals];
+
+    if (internals.onReadCallback) {
+      internals.onReadCallback();
+    }
+
+    return super._read(size);
+  }
+
+  _transform(chunk, encoding, callback) {
+    const self = this;
+    const internals = this[kInternals];
+    const maxRate = internals.maxRate;
+
+    const readableHighWaterMark = this.readableHighWaterMark;
+
+    const timeWindow = internals.timeWindow;
+
+    const divider = 1000 / timeWindow;
+    const bytesThreshold = (maxRate / divider);
+    const minChunkSize = internals.minChunkSize !== false ? Math.max(internals.minChunkSize, bytesThreshold * 0.01) : 0;
+
+    function pushChunk(_chunk, _callback) {
+      const bytes = Buffer.byteLength(_chunk);
+      internals.bytesSeen += bytes;
+      internals.bytes += bytes;
+
+      if (internals.isCaptured) {
+        internals.updateProgress();
+      }
+
+      if (self.push(_chunk)) {
+        process.nextTick(_callback);
+      } else {
+        internals.onReadCallback = () => {
+          internals.onReadCallback = null;
+          process.nextTick(_callback);
+        };
+      }
+    }
+
+    const transformChunk = (_chunk, _callback) => {
+      const chunkSize = Buffer.byteLength(_chunk);
+      let chunkRemainder = null;
+      let maxChunkSize = readableHighWaterMark;
+      let bytesLeft;
+      let passed = 0;
+
+      if (maxRate) {
+        const now = Date.now();
+
+        if (!internals.ts || (passed = (now - internals.ts)) >= timeWindow) {
+          internals.ts = now;
+          bytesLeft = bytesThreshold - internals.bytes;
+          internals.bytes = bytesLeft < 0 ? -bytesLeft : 0;
+          passed = 0;
+        }
+
+        bytesLeft = bytesThreshold - internals.bytes;
+      }
+
+      if (maxRate) {
+        if (bytesLeft <= 0) {
+          // next time window
+          return setTimeout(() => {
+            _callback(null, _chunk);
+          }, timeWindow - passed);
+        }
+
+        if (bytesLeft < maxChunkSize) {
+          maxChunkSize = bytesLeft;
+        }
+      }
+
+      if (maxChunkSize && chunkSize > maxChunkSize && (chunkSize - maxChunkSize) > minChunkSize) {
+        chunkRemainder = _chunk.subarray(maxChunkSize);
+        _chunk = _chunk.subarray(0, maxChunkSize);
+      }
+
+      pushChunk(_chunk, chunkRemainder ? () => {
+        process.nextTick(_callback, null, chunkRemainder);
+      } : _callback);
+    };
+
+    transformChunk(chunk, function transformNextChunk(err, _chunk) {
+      if (err) {
+        return callback(err);
+      }
+
+      if (_chunk) {
+        transformChunk(_chunk, transformNextChunk);
+      } else {
+        callback(null);
+      }
+    });
+  }
+
+  setLength(length) {
+    this[kInternals].length = +length;
+    return this;
+  }
+}
+
+export default AxiosTransformStream;

package/lib/helpers/AxiosURLSearchParams.js

@@ -1,9 +1,17 @@
 'use strict';
 
-var toFormData = require('./toFormData');
-
+import toFormData from './toFormData.js';
+
+/**
+ * It encodes a string by replacing all characters that are not in the unreserved set with
+ * their percent-encoded equivalents
+ *
+ * @param {string} str - The string to encode.
+ *
+ * @returns {string} The encoded string.
+ */
 function encode(str) {
-  var charMap = {
+  const charMap = {
     '!': '%21',
     "'": '%27',
     '(': '%28',
@@ -12,25 +20,33 @@ function encode(str) {
     '%20': '+',
     '%00': '\x00'
   };
-  return encodeURIComponent(str).replace(/[!'\(\)~]|%20|%00/g, function replacer(match) {
+  return encodeURIComponent(str).replace(/[!'()~]|%20|%00/g, function replacer(match) {
     return charMap[match];
   });
 }
 
+/**
+ * It takes a params object and converts it to a FormData object
+ *
+ * @param {Object<string, any>} params - The parameters to be converted to a FormData object.
+ * @param {Object<string, any>} options - The options object passed to the Axios constructor.
+ *
+ * @returns {void}
+ */
 function AxiosURLSearchParams(params, options) {
   this._pairs = [];
 
   params && toFormData(params, this, options);
 }
 
-var prototype = AxiosURLSearchParams.prototype;
+const prototype = AxiosURLSearchParams.prototype;
 
 prototype.append = function append(name, value) {
   this._pairs.push([name, value]);
 };
 
 prototype.toString = function toString(encoder) {
-  var _encode = encoder ? function(value) {
+  const _encode = encoder ? function(value) {
     return encoder.call(this, value, encode);
   } : encode;
 
@@ -39,4 +55,4 @@ prototype.toString = function toString(encoder) {
   }, '').join('&');
 };
 
-module.exports = AxiosURLSearchParams;
+export default AxiosURLSearchParams;

package/lib/helpers/bind.js

@@ -1,7 +1,7 @@
 'use strict';
 
-module.exports = function bind(fn, thisArg) {
+export default function bind(fn, thisArg) {
   return function wrap() {
     return fn.apply(thisArg, arguments);
   };
-};
+}

package/lib/helpers/buildURL.js

@@ -1,8 +1,16 @@
 'use strict';
 
-var utils = require('../utils');
-var AxiosURLSearchParams = require('../helpers/AxiosURLSearchParams');
+import utils from '../utils.js';
+import AxiosURLSearchParams from '../helpers/AxiosURLSearchParams.js';
 
+/**
+ * It replaces all instances of the characters `:`, `$`, `,`, `+`, `[`, and `]` with their
+ * URI encoded counterparts
+ *
+ * @param {string} val The value to be encoded.
+ *
+ * @returns {string} The encoded value.
+ */
 function encode(val) {
   return encodeURIComponent(val).
     replace(/%3A/gi, ':').
@@ -19,23 +27,24 @@ function encode(val) {
  * @param {string} url The base of the url (e.g., http://www.google.com)
  * @param {object} [params] The params to be appended
  * @param {?object} options
+ *
  * @returns {string} The formatted url
  */
-module.exports = function buildURL(url, params, options) {
+export default function buildURL(url, params, options) {
   /*eslint no-param-reassign:0*/
   if (!params) {
     return url;
   }
 
-  var hashmarkIndex = url.indexOf('#');
+  const hashmarkIndex = url.indexOf('#');
 
   if (hashmarkIndex !== -1) {
     url = url.slice(0, hashmarkIndex);
   }
 
-  var _encode = options && options.encode || encode;
+  const _encode = options && options.encode || encode;
 
-  var serializerParams = utils.isURLSearchParams(params) ?
+  const serializerParams = utils.isURLSearchParams(params) ?
     params.toString() :
     new AxiosURLSearchParams(params, options).toString(_encode);
 
@@ -44,4 +53,4 @@ module.exports = function buildURL(url, params, options) {
   }
 
   return url;
-};
+}

package/lib/helpers/combineURLs.js

@@ -5,10 +5,11 @@
  *
  * @param {string} baseURL The base URL
  * @param {string} relativeURL The relative URL
+ *
  * @returns {string} The combined URL
  */
-module.exports = function combineURLs(baseURL, relativeURL) {
+export default function combineURLs(baseURL, relativeURL) {
   return relativeURL
     ? baseURL.replace(/\/+$/, '') + '/' + relativeURL.replace(/^\/+/, '')
     : baseURL;
-};
+}

package/lib/helpers/cookies.js

@@ -1,53 +1,52 @@
 'use strict';
 
-var utils = require('./../utils');
+import utils from './../utils.js';
+import platform from '../platform/index.js';
 
-module.exports = (
-  utils.isStandardBrowserEnv() ?
+export default platform.isStandardBrowserEnv ?
 
-  // Standard browser envs support document.cookie
-    (function standardBrowserEnv() {
-      return {
-        write: function write(name, value, expires, path, domain, secure) {
-          var cookie = [];
-          cookie.push(name + '=' + encodeURIComponent(value));
+// Standard browser envs support document.cookie
+  (function standardBrowserEnv() {
+    return {
+      write: function write(name, value, expires, path, domain, secure) {
+        const cookie = [];
+        cookie.push(name + '=' + encodeURIComponent(value));
 
-          if (utils.isNumber(expires)) {
-            cookie.push('expires=' + new Date(expires).toGMTString());
-          }
-
-          if (utils.isString(path)) {
-            cookie.push('path=' + path);
-          }
-
-          if (utils.isString(domain)) {
-            cookie.push('domain=' + domain);
-          }
-
-          if (secure === true) {
-            cookie.push('secure');
-          }
+        if (utils.isNumber(expires)) {
+          cookie.push('expires=' + new Date(expires).toGMTString());
+        }
 
-          document.cookie = cookie.join('; ');
-        },
+        if (utils.isString(path)) {
+          cookie.push('path=' + path);
+        }
 
-        read: function read(name) {
-          var match = document.cookie.match(new RegExp('(^|;\\s*)(' + name + ')=([^;]*)'));
-          return (match ? decodeURIComponent(match[3]) : null);
-        },
+        if (utils.isString(domain)) {
+          cookie.push('domain=' + domain);
+        }
 
-        remove: function remove(name) {
-          this.write(name, '', Date.now() - 86400000);
+        if (secure === true) {
+          cookie.push('secure');
         }
-      };
-    })() :
-
-  // Non standard browser env (web workers, react-native) lack needed support.
-    (function nonStandardBrowserEnv() {
-      return {
-        write: function write() {},
-        read: function read() { return null; },
-        remove: function remove() {}
-      };
-    })()
-);
+
+        document.cookie = cookie.join('; ');
+      },
+
+      read: function read(name) {
+        const match = document.cookie.match(new RegExp('(^|;\\s*)(' + name + ')=([^;]*)'));
+        return (match ? decodeURIComponent(match[3]) : null);
+      },
+
+      remove: function remove(name) {
+        this.write(name, '', Date.now() - 86400000);
+      }
+    };
+  })() :
+
+// Non standard browser env (web workers, react-native) lack needed support.
+  (function nonStandardBrowserEnv() {
+    return {
+      write: function write() {},
+      read: function read() { return null; },
+      remove: function remove() {}
+    };
+  })();

package/lib/helpers/deprecatedMethod.js

@@ -9,8 +9,10 @@
  * @param {string} method The name of the deprecated method
  * @param {string} [instead] The alternate method to use if applicable
  * @param {string} [docs] The documentation URL to get further details
+ *
+ * @returns {void}
  */
-module.exports = function deprecatedMethod(method, instead, docs) {
+export default function deprecatedMethod(method, instead, docs) {
   try {
     console.warn(
       'DEPRECATED method `' + method + '`.' +
@@ -21,4 +23,4 @@ module.exports = function deprecatedMethod(method, instead, docs) {
       console.warn('For more information about usage see ' + docs);
     }
   } catch (e) { /* Ignore */ }
-};
+}

package/lib/helpers/formDataToJSON.js

@@ -1,23 +1,37 @@
 'use strict';
 
-var utils = require('../utils');
+import utils from '../utils.js';
 
+/**
+ * It takes a string like `foo[x][y][z]` and returns an array like `['foo', 'x', 'y', 'z']
+ *
+ * @param {string} name - The name of the property to get.
+ *
+ * @returns An array of strings.
+ */
 function parsePropPath(name) {
   // foo[x][y][z]
   // foo.x.y.z
   // foo-x-y-z
   // foo x y z
-  return utils.matchAll(/\w+|\[(\w*)]/g, name).map(function(match) {
+  return utils.matchAll(/\w+|\[(\w*)]/g, name).map(match => {
     return match[0] === '[]' ? '' : match[1] || match[0];
   });
 }
 
+/**
+ * Convert an array to an object.
+ *
+ * @param {Array<any>} arr - The array to convert to an object.
+ *
+ * @returns An object with the same keys and values as the array.
+ */
 function arrayToObject(arr) {
-  var obj = {};
-  var keys = Object.keys(arr);
-  var i;
-  var len = keys.length;
-  var key;
+  const obj = {};
+  const keys = Object.keys(arr);
+  let i;
+  const len = keys.length;
+  let key;
   for (i = 0; i < len; i++) {
     key = keys[i];
     obj[key] = arr[key];
@@ -25,15 +39,22 @@ function arrayToObject(arr) {
   return obj;
 }
 
+/**
+ * It takes a FormData object and returns a JavaScript object
+ *
+ * @param {string} formData The FormData object to convert to JSON.
+ *
+ * @returns {Object<string, any> | null} The converted object.
+ */
 function formDataToJSON(formData) {
   function buildPath(path, value, target, index) {
-    var name = path[index++];
-    var isNumericKey = Number.isFinite(+name);
-    var isLast = index >= path.length;
+    let name = path[index++];
+    const isNumericKey = Number.isFinite(+name);
+    const isLast = index >= path.length;
     name = !name && utils.isArray(target) ? target.length : name;
 
     if (isLast) {
-      if (utils.hasOwnProperty(target, name)) {
+      if (utils.hasOwnProp(target, name)) {
         target[name] = [target[name], value];
       } else {
         target[name] = value;
@@ -46,7 +67,7 @@ function formDataToJSON(formData) {
       target[name] = [];
     }
 
-    var result = buildPath(path, value, target[name], index);
+    const result = buildPath(path, value, target[name], index);
 
     if (result && utils.isArray(target[name])) {
       target[name] = arrayToObject(target[name]);
@@ -56,9 +77,9 @@ function formDataToJSON(formData) {
   }
 
   if (utils.isFormData(formData) && utils.isFunction(formData.entries)) {
-    var obj = {};
+    const obj = {};
 
-    utils.forEachEntry(formData, function(name, value) {
+    utils.forEachEntry(formData, (name, value) => {
       buildPath(parsePropPath(name), value, obj, 0);
     });
 
@@ -68,4 +89,4 @@ function formDataToJSON(formData) {
   return null;
 }
 
-module.exports = formDataToJSON;
+export default formDataToJSON;

package/lib/helpers/fromDataURI.js

@@ -1,22 +1,24 @@
 'use strict';
 
-var AxiosError = require('../core/AxiosError');
-var parseProtocol = require('./parseProtocol');
-var platform = require('../platform');
+import AxiosError from '../core/AxiosError.js';
+import parseProtocol from './parseProtocol.js';
+import platform from '../platform/index.js';
 
-var DATA_URL_PATTERN = /^(?:([^;]+);)?(?:[^;]+;)?(base64|),([\s\S]*)$/;
+const DATA_URL_PATTERN = /^(?:([^;]+);)?(?:[^;]+;)?(base64|),([\s\S]*)$/;
 
 /**
  * Parse data uri to a Buffer or Blob
+ *
  * @param {String} uri
  * @param {?Boolean} asBlob
  * @param {?Object} options
  * @param {?Function} options.Blob
+ *
  * @returns {Buffer|Blob}
  */
-module.exports = function fromDataURI(uri, asBlob, options) {
-  var _Blob = options && options.Blob || platform.classes.Blob;
-  var protocol = parseProtocol(uri);
+export default function fromDataURI(uri, asBlob, options) {
+  const _Blob = options && options.Blob || platform.classes.Blob;
+  const protocol = parseProtocol(uri);
 
   if (asBlob === undefined && _Blob) {
     asBlob = true;
@@ -25,16 +27,16 @@ module.exports = function fromDataURI(uri, asBlob, options) {
   if (protocol === 'data') {
     uri = protocol.length ? uri.slice(protocol.length + 1) : uri;
 
-    var match = DATA_URL_PATTERN.exec(uri);
+    const match = DATA_URL_PATTERN.exec(uri);
 
     if (!match) {
       throw new AxiosError('Invalid URL', AxiosError.ERR_INVALID_URL);
     }
 
-    var mime = match[1];
-    var isBase64 = match[2];
-    var body = match[3];
-    var buffer = Buffer.from(decodeURIComponent(body), isBase64 ? 'base64' : 'utf8');
+    const mime = match[1];
+    const isBase64 = match[2];
+    const body = match[3];
+    const buffer = Buffer.from(decodeURIComponent(body), isBase64 ? 'base64' : 'utf8');
 
     if (asBlob) {
       if (!_Blob) {
@@ -48,4 +50,4 @@ module.exports = function fromDataURI(uri, asBlob, options) {
   }
 
   throw new AxiosError('Unsupported protocol ' + protocol, AxiosError.ERR_NOT_SUPPORT);
-};
+}

package/lib/helpers/isAbsoluteURL.js

@@ -4,11 +4,12 @@
  * Determines whether the specified URL is absolute
  *
  * @param {string} url The URL to test
+ *
  * @returns {boolean} True if the specified URL is absolute, otherwise false
  */
-module.exports = function isAbsoluteURL(url) {
+export default function isAbsoluteURL(url) {
   // A URL is considered absolute if it begins with "<scheme>://" or "//" (protocol-relative URL).
   // RFC 3986 defines scheme name as a sequence of characters beginning with a letter and followed
   // by any combination of letters, digits, plus, period, or hyphen.
   return /^([a-z][a-z\d+\-.]*:)?\/\//i.test(url);
-};
+}

package/lib/helpers/isAxiosError.js

@@ -1,13 +1,14 @@
 'use strict';
 
-var utils = require('./../utils');
+import utils from './../utils.js';
 
 /**
  * Determines whether the payload is an error thrown by Axios
  *
  * @param {*} payload The value to test
+ *
  * @returns {boolean} True if the payload is an error thrown by Axios, otherwise false
  */
-module.exports = function isAxiosError(payload) {
+export default function isAxiosError(payload) {
   return utils.isObject(payload) && (payload.isAxiosError === true);
-};
+}