@vantage-sh/vantage-client 0.1.0 → 2.0.0

package/lib/Vantage/ApiClient.js

@@ -1,645 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.ApiClient = void 0;
-
-var _superagent = _interopRequireDefault(require("superagent"));
-
-var _querystring = _interopRequireDefault(require("querystring"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-
-function _typeof(obj) { "@babel/helpers - typeof"; if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); }
-
-function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
-
-function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
-
-function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; }
-
-function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
-
-/**
-* @module Vantage/ApiClient
-* @version 1.0.0
-*/
-
-/**
-* Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
-* application to use this class directly - the *Api and model classes provide the public API for the service. The
-* contents of this file should be regarded as internal but are documented for completeness.
-* @alias module:Vantage/ApiClient
-* @class
-*/
-var ApiClient = /*#__PURE__*/function () {
-  function ApiClient() {
-    _classCallCheck(this, ApiClient);
-
-    /**
-     * The base URL against which to resolve every API call's (relative) path.
-     * @type {String}
-     * @default https://api.vantage.sh
-     */
-    this.basePath = 'https://api.vantage.sh'.replace(/\/+$/, '');
-    /**
-     * The authentication methods to be included for all API calls.
-     * @type {Array.<String>}
-     */
-
-    this.authentications = {
-      'oauth2': {
-        type: 'oauth2'
-      }
-    };
-    /**
-     * The default HTTP headers to be included for all API calls.
-     * @type {Array.<String>}
-     * @default {}
-     */
-
-    this.defaultHeaders = {};
-    /**
-     * The default HTTP timeout for all API calls.
-     * @type {Number}
-     * @default 60000
-     */
-
-    this.timeout = 60000;
-    /**
-     * If set to false an additional timestamp parameter is added to all API GET calls to
-     * prevent browser caching
-     * @type {Boolean}
-     * @default true
-     */
-
-    this.cache = true;
-    /**
-     * If set to true, the client will save the cookies from each server
-     * response, and return them in the next request.
-     * @default false
-     */
-
-    this.enableCookies = false;
-    /*
-     * Used to save and return cookies in a node.js (non-browser) setting,
-     * if this.enableCookies is set to true.
-     */
-
-    if (typeof window === 'undefined') {
-      this.agent = new _superagent["default"].agent();
-    }
-    /*
-     * Allow user to override superagent agent
-     */
-
-
-    this.requestAgent = null;
-  }
-  /**
-  * Returns a string representation for an actual parameter.
-  * @param param The actual parameter.
-  * @returns {String} The string representation of <code>param</code>.
-  */
-
-
-  _createClass(ApiClient, [{
-    key: "paramToString",
-    value: function paramToString(param) {
-      if (param == undefined || param == null) {
-        return '';
-      }
-
-      if (param instanceof Date) {
-        return param.toJSON();
-      }
-
-      return param.toString();
-    }
-    /**
-    * Builds full URL by appending the given path to the base URL and replacing path parameter place-holders with parameter values.
-    * NOTE: query parameters are not handled here.
-    * @param {String} path The path to append to the base URL.
-    * @param {Object} pathParams The parameter values to append.
-    * @returns {String} The encoded path with parameter values substituted.
-    */
-
-  }, {
-    key: "buildUrl",
-    value: function buildUrl(path, pathParams) {
-      var _this = this;
-
-      if (!path.match(/^\//)) {
-        path = '/' + path;
-      }
-
-      var url = this.basePath + path;
-      url = url.replace(/\{([\w-]+)\}/g, function (fullMatch, key) {
-        var value;
-
-        if (pathParams.hasOwnProperty(key)) {
-          value = _this.paramToString(pathParams[key]);
-        } else {
-          value = fullMatch;
-        }
-
-        return encodeURIComponent(value);
-      });
-      return url;
-    }
-    /**
-    * Checks whether the given content type represents JSON.<br>
-    * JSON content type examples:<br>
-    * <ul>
-    * <li>application/json</li>
-    * <li>application/json; charset=UTF8</li>
-    * <li>APPLICATION/JSON</li>
-    * </ul>
-    * @param {String} contentType The MIME content type to check.
-    * @returns {Boolean} <code>true</code> if <code>contentType</code> represents JSON, otherwise <code>false</code>.
-    */
-
-  }, {
-    key: "isJsonMime",
-    value: function isJsonMime(contentType) {
-      return Boolean(contentType != null && contentType.match(/^application\/json(;.*)?$/i));
-    }
-    /**
-    * Chooses a content type from the given array, with JSON preferred; i.e. return JSON if included, otherwise return the first.
-    * @param {Array.<String>} contentTypes
-    * @returns {String} The chosen content type, preferring JSON.
-    */
-
-  }, {
-    key: "jsonPreferredMime",
-    value: function jsonPreferredMime(contentTypes) {
-      for (var i = 0; i < contentTypes.length; i++) {
-        if (this.isJsonMime(contentTypes[i])) {
-          return contentTypes[i];
-        }
-      }
-
-      return contentTypes[0];
-    }
-    /**
-    * Checks whether the given parameter value represents file-like content.
-    * @param param The parameter to check.
-    * @returns {Boolean} <code>true</code> if <code>param</code> represents a file.
-    */
-
-  }, {
-    key: "isFileParam",
-    value: function isFileParam(param) {
-      // fs.ReadStream in Node.js and Electron (but not in runtime like browserify)
-      if (typeof require === 'function') {
-        var fs;
-
-        try {
-          fs = require('fs');
-        } catch (err) {}
-
-        if (fs && fs.ReadStream && param instanceof fs.ReadStream) {
-          return true;
-        }
-      } // Buffer in Node.js
-
-
-      if (typeof Buffer === 'function' && param instanceof Buffer) {
-        return true;
-      } // Blob in browser
-
-
-      if (typeof Blob === 'function' && param instanceof Blob) {
-        return true;
-      } // File in browser (it seems File object is also instance of Blob, but keep this for safe)
-
-
-      if (typeof File === 'function' && param instanceof File) {
-        return true;
-      }
-
-      return false;
-    }
-    /**
-    * Normalizes parameter values:
-    * <ul>
-    * <li>remove nils</li>
-    * <li>keep files and arrays</li>
-    * <li>format to string with `paramToString` for other cases</li>
-    * </ul>
-    * @param {Object.<String, Object>} params The parameters as object properties.
-    * @returns {Object.<String, Object>} normalized parameters.
-    */
-
-  }, {
-    key: "normalizeParams",
-    value: function normalizeParams(params) {
-      var newParams = {};
-
-      for (var key in params) {
-        if (params.hasOwnProperty(key) && params[key] != undefined && params[key] != null) {
-          var value = params[key];
-
-          if (this.isFileParam(value) || Array.isArray(value)) {
-            newParams[key] = value;
-          } else {
-            newParams[key] = this.paramToString(value);
-          }
-        }
-      }
-
-      return newParams;
-    }
-    /**
-    * Enumeration of collection format separator strategies.
-    * @enum {String}
-    * @readonly
-    */
-
-  }, {
-    key: "buildCollectionParam",
-    value:
-    /**
-    * Builds a string representation of an array-type actual parameter, according to the given collection format.
-    * @param {Array} param An array parameter.
-    * @param {module:Vantage/ApiClient.CollectionFormatEnum} collectionFormat The array element separator strategy.
-    * @returns {String|Array} A string representation of the supplied collection, using the specified delimiter. Returns
-    * <code>param</code> as is if <code>collectionFormat</code> is <code>multi</code>.
-    */
-    function buildCollectionParam(param, collectionFormat) {
-      if (param == null) {
-        return null;
-      }
-
-      switch (collectionFormat) {
-        case 'csv':
-          return param.map(this.paramToString).join(',');
-
-        case 'ssv':
-          return param.map(this.paramToString).join(' ');
-
-        case 'tsv':
-          return param.map(this.paramToString).join('\t');
-
-        case 'pipes':
-          return param.map(this.paramToString).join('|');
-
-        case 'multi':
-          //return the array directly as SuperAgent will handle it as expected
-          return param.map(this.paramToString);
-
-        default:
-          throw new Error('Unknown collection format: ' + collectionFormat);
-      }
-    }
-    /**
-    * Applies authentication headers to the request.
-    * @param {Object} request The request object created by a <code>superagent()</code> call.
-    * @param {Array.<String>} authNames An array of authentication method names.
-    */
-
-  }, {
-    key: "applyAuthToRequest",
-    value: function applyAuthToRequest(request, authNames) {
-      var _this2 = this;
-
-      authNames.forEach(function (authName) {
-        var auth = _this2.authentications[authName];
-
-        switch (auth.type) {
-          case 'basic':
-            if (auth.username || auth.password) {
-              request.auth(auth.username || '', auth.password || '');
-            }
-
-            break;
-
-          case 'apiKey':
-            if (auth.apiKey) {
-              var data = {};
-
-              if (auth.apiKeyPrefix) {
-                data[auth.name] = auth.apiKeyPrefix + ' ' + auth.apiKey;
-              } else {
-                data[auth.name] = auth.apiKey;
-              }
-
-              if (auth['in'] === 'header') {
-                request.set(data);
-              } else {
-                request.query(data);
-              }
-            }
-
-            break;
-
-          case 'oauth2':
-            if (auth.accessToken) {
-              request.set({
-                'Authorization': 'Bearer ' + auth.accessToken
-              });
-            }
-
-            break;
-
-          default:
-            throw new Error('Unknown authentication type: ' + auth.type);
-        }
-      });
-    }
-    /**
-    * Deserializes an HTTP response body into a value of the specified type.
-    * @param {Object} response A SuperAgent response object.
-    * @param {(String|Array.<String>|Object.<String, Object>|Function)} returnType The type to return. Pass a string for simple types
-    * or the constructor function for a complex type. Pass an array containing the type name to return an array of that type. To
-    * return an object, pass an object with one property whose name is the key type and whose value is the corresponding value type:
-    * all properties on <code>data<code> will be converted to this type.
-    * @returns A value of the specified type.
-    */
-
-  }, {
-    key: "deserialize",
-    value: function deserialize(response, returnType) {
-      if (response == null || returnType == null || response.status == 204) {
-        return null;
-      } // Rely on SuperAgent for parsing response body.
-      // See http://visionmedia.github.io/superagent/#parsing-response-bodies
-
-
-      var data = response.body;
-
-      if (data == null || _typeof(data) === 'object' && typeof data.length === 'undefined' && !Object.keys(data).length) {
-        // SuperAgent does not always produce a body; use the unparsed response as a fallback
-        data = response.text;
-      }
-
-      return ApiClient.convertToType(data, returnType);
-    }
-    /**
-    * Invokes the REST service using the supplied settings and parameters.
-    * @param {String} path The base URL to invoke.
-    * @param {String} httpMethod The HTTP method to use.
-    * @param {Object.<String, String>} pathParams A map of path parameters and their values.
-    * @param {Object.<String, Object>} queryParams A map of query parameters and their values.
-    * @param {Object.<String, Object>} headerParams A map of header parameters and their values.
-    * @param {Object.<String, Object>} formParams A map of form parameters and their values.
-    * @param {Object} bodyParam The value to pass as the request body.
-    * @param {Array.<String>} authNames An array of authentication type names.
-    * @param {Array.<String>} contentTypes An array of request MIME types.
-    * @param {Array.<String>} accepts An array of acceptable response MIME types.
-    * @param {(String|Array|ObjectFunction)} returnType The required type to return; can be a string for simple types or the
-    * constructor for a complex type.
-    * @returns {Promise} A {@link https://www.promisejs.org/|Promise} object.
-    */
-
-  }, {
-    key: "callApi",
-    value: function callApi(path, httpMethod, pathParams, queryParams, headerParams, formParams, bodyParam, authNames, contentTypes, accepts, returnType) {
-      var _this3 = this;
-
-      var url = this.buildUrl(path, pathParams);
-      var request = (0, _superagent["default"])(httpMethod, url); // apply authentications
-
-      this.applyAuthToRequest(request, authNames); // set query parameters
-
-      if (httpMethod.toUpperCase() === 'GET' && this.cache === false) {
-        queryParams['_'] = new Date().getTime();
-      }
-
-      request.query(this.normalizeParams(queryParams)); // set header parameters
-
-      request.set(this.defaultHeaders).set(this.normalizeParams(headerParams)); // set requestAgent if it is set by user
-
-      if (this.requestAgent) {
-        request.agent(this.requestAgent);
-      } // set request timeout
-
-
-      request.timeout(this.timeout);
-      var contentType = this.jsonPreferredMime(contentTypes);
-
-      if (contentType) {
-        // Issue with superagent and multipart/form-data (https://github.com/visionmedia/superagent/issues/746)
-        if (contentType != 'multipart/form-data') {
-          request.type(contentType);
-        }
-      } else if (!request.header['Content-Type']) {
-        request.type('application/json');
-      }
-
-      if (contentType === 'application/x-www-form-urlencoded') {
-        request.send(_querystring["default"].stringify(this.normalizeParams(formParams)));
-      } else if (contentType == 'multipart/form-data') {
-        var _formParams = this.normalizeParams(formParams);
-
-        for (var key in _formParams) {
-          if (_formParams.hasOwnProperty(key)) {
-            if (this.isFileParam(_formParams[key])) {
-              // file field
-              request.attach(key, _formParams[key]);
-            } else {
-              request.field(key, _formParams[key]);
-            }
-          }
-        }
-      } else if (bodyParam) {
-        request.send(bodyParam);
-      }
-
-      var accept = this.jsonPreferredMime(accepts);
-
-      if (accept) {
-        request.accept(accept);
-      }
-
-      if (returnType === 'Blob') {
-        request.responseType('blob');
-      } else if (returnType === 'String') {
-        request.responseType('string');
-      } // Attach previously saved cookies, if enabled
-
-
-      if (this.enableCookies) {
-        if (typeof window === 'undefined') {
-          this.agent.attachCookies(request);
-        } else {
-          request.withCredentials();
-        }
-      }
-
-      return new Promise(function (resolve, reject) {
-        request.end(function (error, response) {
-          if (error) {
-            reject(error);
-          } else {
-            try {
-              var data = _this3.deserialize(response, returnType);
-
-              if (_this3.enableCookies && typeof window === 'undefined') {
-                _this3.agent.saveCookies(response);
-              }
-
-              resolve({
-                data: data,
-                response: response
-              });
-            } catch (err) {
-              reject(err);
-            }
-          }
-        });
-      });
-    }
-    /**
-    * Parses an ISO-8601 string representation of a date value.
-    * @param {String} str The date value as a string.
-    * @returns {Date} The parsed date object.
-    */
-
-  }], [{
-    key: "parseDate",
-    value: function parseDate(str) {
-      return new Date(str);
-    }
-    /**
-    * Converts a value to the specified type.
-    * @param {(String|Object)} data The data to convert, as a string or object.
-    * @param {(String|Array.<String>|Object.<String, Object>|Function)} type The type to return. Pass a string for simple types
-    * or the constructor function for a complex type. Pass an array containing the type name to return an array of that type. To
-    * return an object, pass an object with one property whose name is the key type and whose value is the corresponding value type:
-    * all properties on <code>data<code> will be converted to this type.
-    * @returns An instance of the specified type or null or undefined if data is null or undefined.
-    */
-
-  }, {
-    key: "convertToType",
-    value: function convertToType(data, type) {
-      if (data === null || data === undefined) return data;
-
-      switch (type) {
-        case 'Boolean':
-          return Boolean(data);
-
-        case 'Integer':
-          return parseInt(data, 10);
-
-        case 'Number':
-          return parseFloat(data);
-
-        case 'String':
-          return String(data);
-
-        case 'Date':
-          return ApiClient.parseDate(String(data));
-
-        case 'Blob':
-          return data;
-
-        default:
-          if (type === Object) {
-            // generic object, return directly
-            return data;
-          } else if (typeof type === 'function') {
-            // for model type like: User
-            return type.constructFromObject(data);
-          } else if (Array.isArray(type)) {
-            // for array type like: ['String']
-            var itemType = type[0];
-            return data.map(function (item) {
-              return ApiClient.convertToType(item, itemType);
-            });
-          } else if (_typeof(type) === 'object') {
-            // for plain object type like: {'String': 'Integer'}
-            var keyType, valueType;
-
-            for (var k in type) {
-              if (type.hasOwnProperty(k)) {
-                keyType = k;
-                valueType = type[k];
-                break;
-              }
-            }
-
-            var result = {};
-
-            for (var k in data) {
-              if (data.hasOwnProperty(k)) {
-                var key = ApiClient.convertToType(k, keyType);
-                var value = ApiClient.convertToType(data[k], valueType);
-                result[key] = value;
-              }
-            }
-
-            return result;
-          } else {
-            // for unknown type, return the data directly
-            return data;
-          }
-
-      }
-    }
-    /**
-    * Constructs a new map or array model from REST data.
-    * @param data {Object|Array} The REST data.
-    * @param obj {Object|Array} The target object or array.
-    */
-
-  }, {
-    key: "constructFromObject",
-    value: function constructFromObject(data, obj, itemType) {
-      if (Array.isArray(data)) {
-        for (var i = 0; i < data.length; i++) {
-          if (data.hasOwnProperty(i)) obj[i] = ApiClient.convertToType(data[i], itemType);
-        }
-      } else {
-        for (var k in data) {
-          if (data.hasOwnProperty(k)) obj[k] = ApiClient.convertToType(data[k], itemType);
-        }
-      }
-    }
-  }]);
-
-  return ApiClient;
-}();
-/**
-* The default API client implementation.
-* @type {module:Vantage/ApiClient}
-*/
-
-
-exports.ApiClient = ApiClient;
-
-_defineProperty(ApiClient, "CollectionFormatEnum", {
-  /**
-   * Comma-separated values. Value: <code>csv</code>
-   * @const
-   */
-  CSV: ',',
-
-  /**
-   * Space-separated values. Value: <code>ssv</code>
-   * @const
-   */
-  SSV: ' ',
-
-  /**
-   * Tab-separated values. Value: <code>tsv</code>
-   * @const
-   */
-  TSV: '\t',
-
-  /**
-   * Pipe(|)-separated values. Value: <code>pipes</code>
-   * @const
-   */
-  PIPES: '|',
-
-  /**
-   * Native array. Value: <code>multi</code>
-   * @const
-   */
-  MULTI: 'multi'
-});
-
-ApiClient.instance = new ApiClient();