-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathmethods_fetch.js.html
More file actions
196 lines (157 loc) · 7.45 KB
/
Copy pathmethods_fetch.js.html
File metadata and controls
196 lines (157 loc) · 7.45 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>methods/fetch.js - Documentation</title>
<script src="scripts/prettify/prettify.js"></script>
<script src="scripts/prettify/lang-css.js"></script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
<script src="scripts/nav.js" defer></script>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
</head>
<body>
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
<div class="navicon"></div>
</label>
<label for="nav-trigger" class="overlay"></label>
<nav >
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="EcomSearch.html">EcomSearch</a><ul class='methods'><li data-type='method'><a href="EcomSearch.html#fetch">fetch</a></li><li data-type='method'><a href="EcomSearch.html#getBrands">getBrands</a></li><li data-type='method'><a href="EcomSearch.html#getCategories">getCategories</a></li><li data-type='method'><a href="EcomSearch.html#getItems">getItems</a></li><li data-type='method'><a href="EcomSearch.html#getPriceRange">getPriceRange</a></li><li data-type='method'><a href="EcomSearch.html#getSpecs">getSpecs</a></li><li data-type='method'><a href="EcomSearch.html#getTermSuggestions">getTermSuggestions</a></li><li data-type='method'><a href="EcomSearch.html#getTotalCount">getTotalCount</a></li><li data-type='method'><a href="EcomSearch.html#mergeFilter">mergeFilter</a></li><li data-type='method'><a href="EcomSearch.html#removeFilter">removeFilter</a></li><li data-type='method'><a href="EcomSearch.html#reset">reset</a></li><li data-type='method'><a href="EcomSearch.html#setBrandIds">setBrandIds</a></li><li data-type='method'><a href="EcomSearch.html#setBrandNames">setBrandNames</a></li><li data-type='method'><a href="EcomSearch.html#setCategoryIds">setCategoryIds</a></li><li data-type='method'><a href="EcomSearch.html#setCategoryNames">setCategoryNames</a></li><li data-type='method'><a href="EcomSearch.html#setPageNumber">setPageNumber</a></li><li data-type='method'><a href="EcomSearch.html#setPageSize">setPageSize</a></li><li data-type='method'><a href="EcomSearch.html#setPriceRange">setPriceRange</a></li><li data-type='method'><a href="EcomSearch.html#setProductIds">setProductIds</a></li><li data-type='method'><a href="EcomSearch.html#setSearchTerm">setSearchTerm</a></li><li data-type='method'><a href="EcomSearch.html#setSkus">setSkus</a></li><li data-type='method'><a href="EcomSearch.html#setSortOrder">setSortOrder</a></li><li data-type='method'><a href="EcomSearch.html#setSpec">setSpec</a></li></ul></li></ul><h3>Modules</h3><ul><li><a href="module-@ecomplus_search-engine.html">@ecomplus/search-engine</a></li></ul><h3>Global</h3><ul><li><a href="global.html#addGlobalFilter">addGlobalFilter</a></li><li><a href="global.html#setSalesChannel">setSalesChannel</a></li><li><a href="global.html#setWarehouse">setWarehouse</a></li></ul>
</nav>
<div id="main">
<h1 class="page-title">methods/fetch.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>import { search } from '@ecomplus/client'
import * as cloneDeep from 'lodash.clonedeep'
import dslMiddlewares from './../lib/dsl-middlewares'
export default (self, isSimpleSearch, axiosConfig) => {
// mount axios req options for complex or simpĺe search
const { storeId } = self
const reqOptions = {
url: '/items.json',
storeId,
axiosConfig
}
// prepare search DSL
let dsl = cloneDeep(self.dsl)
dslMiddlewares.forEach(fn => {
if (typeof fn === 'function') {
const _dsl = fn(dsl)
if (_dsl) {
dsl = _dsl
}
}
})
if (isSimpleSearch === true) {
// https://www.elastic.co/guide/en/elasticsearch/reference/6.3/search-uri-request.html
const { query } = dsl
reqOptions.url += '?q='
if (query && query.bool && Array.isArray(query.bool.filter)) {
// parse query filters to string
let queryString = ''
query.bool.filter.forEach(({ term, terms }, i) => {
if (i > 0) {
queryString += ' AND '
}
const condition = term || terms
if (condition) {
const field = Object.keys(condition)[0]
const value = condition[field]
queryString += `${field}:${(Array.isArray(value) ? `("${value.join('" "')}")` : value)}`
}
})
reqOptions.url += encodeURIComponent(queryString)
}
// handle pagination
;['from', 'size'].forEach(field => {
if (dsl[field]) {
reqOptions.url += `&${field}=${dsl[field]}`
}
})
} else {
reqOptions.method = 'post'
reqOptions.data = dsl
if (isSimpleSearch && !axiosConfig) {
// fallback for old reference with `fetch(axiosConfig)`
reqOptions.axiosConfig = isSimpleSearch
}
}
// request Search API and return promise
return search(reqOptions).then(({ data }) => {
// save last result on instance
self.result = data
const { dsl, history, localStorage, storageKey } = self
if (data.hits.total && dsl && dsl.suggest) {
const { text } = dsl.suggest
if (text) {
// add search term to history
const index = history.indexOf(text)
if (index > -1) {
// prevent duplicated term
history.splice(index, 1)
}
history.unshift(text)
if (localStorage && storageKey) {
localStorage.setItem(storageKey, history.slice(0, 20).join('||'))
}
}
}
// resolving with response data
return data
})
}
/**
* @typedef {object} result
* @property {object} hits - Elasticsearch hits object
* @property {number} hits.total - Total number of products found
* @property {array<object>} hits.hits - List of resultant items
* @property {object} aggregations - Elasticsearch aggregations results
* @property {object} suggest - Search term suggestions object
* @property {number} took - Request time in milliseconds
*/
/**
* @method
* @name EcomSearch#fetch
* @description Send POST request to
* [E-Com Plus Search API]{@link https://developers.e-com.plus/docs/api/#/search/items/items}
* and returns promise resolved with search result.
*
* @param {boolean} [isSimpleSearch=false] - Handle simple (and faster) search without sort and aggregations
* @param {object} [axiosConfig] - Additional
* [axios config]{@link https://github.com/axios/axios#request-config} object
*
* @returns {Promise<result|error>}
*
* @example
// Run search request
search.fetch()
.then(result => {
console.log(result.took)
console.log(`${result.hits.total} items found:`)
console.log(result.hits.hits)
})
.catch(error => {
console.error(error)
if (error.response) {
console.log(error.response)
}
})
*/
</code></pre>
</article>
</section>
</div>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Wed Feb 22 2023 20:40:42 GMT-0300 (Brasilia Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
</footer>
<script>prettyPrint();</script>
<script src="scripts/polyfill.js"></script>
<script src="scripts/linenumber.js"></script>
</body>
</html>