feat(method): new 'requestSearchApi' method

src/index.js

@@ -7,6 +7,7 @@
 import _self from './lib/self'
 
 import requestStoreApi from './methods/request-store-api'
+import requestSearchApi from './methods/request-search-api'
 
 /**
  * JS client for E-Com Plus REST APIs.
@@ -28,7 +29,8 @@ import requestStoreApi from './methods/request-store-api'
 
 export {
   _self,
-  requestStoreApi
+  requestStoreApi,
+  requestSearchApi
 }
 
 /**

src/methods/request-search-api.js

@@ -0,0 +1,78 @@
+import { _config } from '@ecomplus/utils'
+import { IS_BROWSER, API_SEARCH } from './../lib/constants'
+import axios from './../lib/axios'
+
+// returns axios request promise
+const requestSearchApi = (
+  url,
+  method = 'get',
+  data,
+  storeId = _config.get('store_id'),
+  axiosConfig
+) => axios.request({
+  data,
+  // set 10s default timeout for search requests on browser
+  timeout: IS_BROWSER ? 10000 : 30000,
+  ...axiosConfig,
+  url,
+  baseURL: API_SEARCH,
+  method,
+  headers: {
+    'X-Store-ID': storeId
+  }
+})
+
+/**
+ * @method
+ * @memberof ecomClient
+ * @name requestSearchApi
+ * @description Send HTTP request to
+ * [E-Com Plus Search REST API]{@link https://developers.e-com.plus/docs/api/#/search/}.
+ *
+ * @param {string} url - API endpoint to request or absolute URI
+ * @param {string} [method='get'] - Request method (HTTP verb)
+ * @param {object} [data] - Request body object
+ * @param {number} [storeId=_config.get('store_id')] - E-Com Plus Store ID number
+ * @param {object} [axiosConfig] - Additional
+ * [axios config]{@link https://github.com/axios/axios#request-config} settings
+ *
+ * @returns {Promise<response|error>}
+ * Axios request promise resolved with
+ * [response]{@link https://github.com/axios/axios#response-schema}
+ * or rejected with
+ * [error]{@link https://github.com/axios/axios#handling-errors}.
+ *
+ * @example
+
+// Simple search request (ELS URI Search)
+ecomClient.requestSearchApi('/items.json?q=sku:123')
+  .then(response => console.log(response.data))
+  .catch(error => {
+    console.error(error)
+    if (error.response) {
+      console.log(error.response)
+    }
+  })
+
+ * @example
+
+// Complex search request (ELS Request Body Search)
+const data = {
+  query: {
+    bool: {
+      must: {
+        multi_match: {
+          query: 'tshirt',
+          fields: [ 'name', 'keywords' ]
+        }
+      }
+    }
+  }
+}
+ecomClient.requestSearchApi('/items.json', 'post', data)
+  .then(({ data, status }) => console.log(status, data))
+  .catch(error => console.error(error))
+
+ */
+
+export default requestSearchApi