Source: api/api/http.js

  1. /*
  2.  * Copyright OpenSearch Contributors
  3.  * SPDX-License-Identifier: Apache-2.0
  4.  *
  5.  * The OpenSearch Contributors require contributions made to
  6.  * this file be licensed under the Apache-2.0 license or a
  7.  * compatible open source license.
  8.  *
  9.  */
  11. 'use strict';
  13. /** @namespace API-HTTP */
  15. const { normalizeArguments, kConfigurationError } = require('../utils');
  17. function HttpApi(transport, ConfigurationError) {
  18.   this.transport = transport;
  19.   this[kConfigurationError] = ConfigurationError;
  20. }
  22. HttpApi.prototype.request = function (method, params, options, callback) {
  23.   [params, options, callback] = normalizeArguments(params, options, callback);
  24.   if (Array.isArray(params.body)) {
  25.     const { path, querystring, headers, body } = params;
  26.     params = { path, querystring, headers, bulkBody: body };
  27.   }
  28.   options = options || {};
  29.   options.headers = params.headers || options.headers;
  30.   return this.transport.request({ ...params, method }, options, callback);
  31. };
  33. /**
  34.  * Make a customized CONNECT request.
  35.  *
  36.  * @memberOf API-HTTP
  37.  *
  38.  * @param {Object} params
  39.  * @param {Object} params.path - The URL of the request
  40.  * @param {Object} [params.querystring] - The querystring parameters
  41.  * @param {Object} [params.headers] - The request headers
  42.  * @param {Object} [params.body] - The request body
  43.  *
  44.  * @param {Object} [options] - Options for {@link Transport#request}
  45.  * @param {function} [callback] - Callback that handles errors and response
  46.  *
  47.  * @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*}
  48.  */
  49. HttpApi.prototype.connect = function (params, options, callback) {
  50.   return this.request('CONNECT', params, options, callback);
  51. };
  53. /**
  54.  * Make a customized DELETE request.
  55.  *
  56.  * @memberOf API-HTTP
  57.  *
  58.  * @param {Object} params
  59.  * @param {Object} params.path - The URL of the request
  60.  * @param {Object} [params.querystring] - The querystring parameters
  61.  * @param {Object} [params.headers] - The request headers
  62.  * @param {Object} [params.body] - The request body
  63.  *
  64.  * @param {Object} [options] - Options for {@link Transport#request}
  65.  * @param {function} [callback] - Callback that handles errors and response
  66.  *
  67.  * @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*}
  68.  */
  69. HttpApi.prototype.delete = function (params, options, callback) {
  70.   return this.request('DELETE', params, options, callback);
  71. };
  73. /**
  74.  * Make a customized GET request.
  75.  *
  76.  * @memberOf API-HTTP
  77.  *
  78.  * @param {Object} params
  79.  * @param {Object} params.path - The URL of the request
  80.  * @param {Object} [params.querystring] - The querystring parameters
  81.  * @param {Object} [params.headers] - The request headers
  82.  * @param {Object} [params.body] - The request body
  83.  *
  84.  * @param {Object} [options] - Options for {@link Transport#request}
  85.  * @param {function} [callback] - Callback that handles errors and response
  86.  *
  87.  * @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*}
  88.  */
  89. HttpApi.prototype.get = function (params, options, callback) {
  90.   return this.request('GET', params, options, callback);
  91. };
  93. /**
  94.  * Make a customized HEAD request.
  95.  *
  96.  * @memberOf API-HTTP
  97.  *
  98.  * @param {Object} params
  99.  * @param {Object} params.path - The URL of the request
  100.  * @param {Object} [params.querystring] - The querystring parameters
  101.  * @param {Object} [params.headers] - The request headers
  102.  * @param {Object} [params.body] - The request body
  103.  *
  104.  * @param {Object} [options] - Options for {@link Transport#request}
  105.  * @param {function} [callback] - Callback that handles errors and response
  106.  *
  107.  * @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*}
  108.  */
  109. HttpApi.prototype.head = function (params, options, callback) {
  110.   return this.request('HEAD', params, options, callback);
  111. };
  113. /**
  114.  * Make a customized OPTIONS request.
  115.  *
  116.  * @memberOf API-HTTP
  117.  *
  118.  * @param {Object} params
  119.  * @param {Object} params.path - The URL of the request
  120.  * @param {Object} [params.querystring] - The querystring parameters
  121.  * @param {Object} [params.headers] - The request headers
  122.  * @param {Object} [params.body] - The request body
  123.  *
  124.  * @param {Object} [options] - Options for {@link Transport#request}
  125.  * @param {function} [callback] - Callback that handles errors and response
  126.  *
  127.  * @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*}
  128.  */
  129. HttpApi.prototype.options = function (params, options, callback) {
  130.   return this.request('OPTIONS', params, options, callback);
  131. };
  133. /**
  134.  * Make a customized PATCH request.
  135.  *
  136.  * @memberOf API-HTTP
  137.  *
  138.  * @param {Object} params
  139.  * @param {Object} params.path - The URL of the request
  140.  * @param {Object} [params.querystring] - The querystring parameters
  141.  * @param {Object} [params.headers] - The request headers
  142.  * @param {Object} [params.body] - The request body
  143.  *
  144.  * @param {Object} [options] - Options for {@link Transport#request}
  145.  * @param {function} [callback] - Callback that handles errors and response
  146.  *
  147.  * @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*}
  148.  */
  149. HttpApi.prototype.patch = function (params, options, callback) {
  150.   return this.request('PATCH', params, options, callback);
  151. };
  153. /**
  154.  * Make a customized POST request.
  155.  *
  156.  * @memberOf API-HTTP
  157.  *
  158.  * @param {Object} params
  159.  * @param {Object} params.path - The URL of the request
  160.  * @param {Object} [params.querystring] - The querystring parameters
  161.  * @param {Object} [params.headers] - The request headers
  162.  * @param {Object} [params.body] - The request body
  163.  *
  164.  * @param {Object} [options] - Options for {@link Transport#request}
  165.  * @param {function} [callback] - Callback that handles errors and response
  166.  *
  167.  * @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*}
  168.  */
  169. HttpApi.prototype.post = function (params, options, callback) {
  170.   return this.request('POST', params, options, callback);
  171. };
  173. /**
  174.  * Make a customized PUT request.
  175.  *
  176.  * @memberOf API-HTTP
  177.  *
  178.  * @param {Object} params
  179.  * @param {Object} params.path - The URL of the request
  180.  * @param {Object} [params.querystring] - The querystring parameters
  181.  * @param {Object} [params.headers] - The request headers
  182.  * @param {Object} [params.body] - The request body
  183.  *
  184.  * @param {Object} [options] - Options for {@link Transport#request}
  185.  * @param {function} [callback] - Callback that handles errors and response
  186.  *
  187.  * @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*}
  188.  */
  189. HttpApi.prototype.put = function (params, options, callback) {
  190.   return this.request('PUT', params, options, callback);
  191. };
  193. /**
  194.  * Make a customized TRACE request.
  195.  *
  196.  * @memberOf API-HTTP
  197.  *
  198.  * @param {Object} params
  199.  * @param {Object} params.path - The URL of the request
  200.  * @param {Object} [params.querystring] - The querystring parameters
  201.  * @param {Object} [params.headers] - The request headers
  202.  * @param {Object} [params.body] - The request body
  203.  *
  204.  * @param {Object} [options] - Options for {@link Transport#request}
  205.  * @param {function} [callback] - Callback that handles errors and response
  206.  *
  207.  * @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*}
  208.  */
  209. HttpApi.prototype.trace = function (params, options, callback) {
  210.   return this.request('TRACE', params, options, callback);
  211. };
  213. module.exports = HttpApi;