Skip to content

Commit 55c19f8

Browse files
esezenesezen
committed
Add filterMatchTypes to search
1 parent d389628 commit 55c19f8

22 files changed

+90
-41
lines changed

‎dist/constructorio-client-javascript-2.59.1.js

-16
This file was deleted.

‎dist/constructorio-client-javascript-2.59.2.js

+16
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/ConstructorIO.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1607,7 +1607,7 @@ <h6>Properties</h6>
16071607
<br class="clear">
16081608

16091609
<footer>
1610-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Dec 03 2024 19:21:33 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
1610+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Dec 03 2024 19:24:18 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
16111611
</footer>
16121612

16131613
<script>prettyPrint();</script>

‎docs/constructorio.js.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -254,7 +254,7 @@ <h1 class="page-title">constructorio.js</h1>
254254
<br class="clear">
255255

256256
<footer>
257-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Dec 03 2024 19:21:33 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
257+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Dec 03 2024 19:24:18 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
258258
</footer>
259259

260260
<script>prettyPrint();</script>

‎docs/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ <h2>Development / npm commands</h2>
114114
<br class="clear">
115115

116116
<footer>
117-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Dec 03 2024 19:21:33 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
117+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Dec 03 2024 19:24:18 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
118118
</footer>
119119

120120
<script>prettyPrint();</script>

‎docs/module-assistant.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -457,7 +457,7 @@ <h5 class="h5-returns">Returns:</h5>
457457
<br class="clear">
458458

459459
<footer>
460-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Dec 03 2024 19:21:33 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
460+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Dec 03 2024 19:24:18 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
461461
</footer>
462462

463463
<script>prettyPrint();</script>

‎docs/module-autocomplete.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -798,7 +798,7 @@ <h5 class="h5-returns">Returns:</h5>
798798
<br class="clear">
799799

800800
<footer>
801-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Dec 03 2024 19:21:33 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
801+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Dec 03 2024 19:24:18 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
802802
</footer>
803803

804804
<script>prettyPrint();</script>

‎docs/module-browse.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -3216,7 +3216,7 @@ <h5 class="h5-returns">Returns:</h5>
32163216
<br class="clear">
32173217

32183218
<footer>
3219-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Dec 03 2024 19:21:33 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
3219+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Dec 03 2024 19:24:18 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
32203220
</footer>
32213221

32223222
<script>prettyPrint();</script>

‎docs/module-quizzes.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1661,7 +1661,7 @@ <h5 class="h5-returns">Returns:</h5>
16611661
<br class="clear">
16621662

16631663
<footer>
1664-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Dec 03 2024 19:21:33 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
1664+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Dec 03 2024 19:24:18 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
16651665
</footer>
16661666

16671667
<script>prettyPrint();</script>

‎docs/module-recommendations.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -764,7 +764,7 @@ <h5 class="h5-returns">Returns:</h5>
764764
<br class="clear">
765765

766766
<footer>
767-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Dec 03 2024 19:21:33 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
767+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Dec 03 2024 19:24:18 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
768768
</footer>
769769

770770
<script>prettyPrint();</script>

‎docs/module-search.html

+45-4
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ <h1 class="page-title">search</h1>
6666

6767
<dt class="tag-source">Source:</dt>
6868
<dd class="tag-source"><ul class="dummy"><li>
69-
<a href="modules_search.js.html">modules/search.js</a>, <a href="modules_search.js.html#line134">line 134</a>
69+
<a href="modules_search.js.html">modules/search.js</a>, <a href="modules_search.js.html#line138">line 138</a>
7070
</li></ul></dd>
7171

7272

@@ -151,7 +151,7 @@ <h4 class="name" id="~getSearchResults"><span class="type-signature type-signatu
151151

152152
<dt class="tag-source">Source:</dt>
153153
<dd class="tag-source"><ul class="dummy"><li>
154-
<a href="modules_search.js.html">modules/search.js</a>, <a href="modules_search.js.html#line147">line 147</a>
154+
<a href="modules_search.js.html">modules/search.js</a>, <a href="modules_search.js.html#line151">line 151</a>
155155
</li></ul></dd>
156156

157157

@@ -210,6 +210,9 @@ <h5 class="h5-examples">Example</h5>
210210
filters: {
211211
size: 'medium'
212212
},
213+
filterMatchTypes: {
214+
size: 'all'
215+
}
213216
});</code></pre>
214217

215218

@@ -828,6 +831,44 @@ <h6>Properties</h6>
828831
</tr>
829832

830833

834+
835+
<tr>
836+
837+
<td class="name"><code>filterMatchTypes</code></td>
838+
839+
840+
<td class="type">
841+
842+
843+
<span class="param-type">object</span>
844+
845+
846+
847+
848+
</td>
849+
850+
851+
<td class="attributes">
852+
853+
&lt;optional><br>
854+
855+
856+
857+
858+
859+
</td>
860+
861+
862+
863+
<td class="default">
864+
865+
</td>
866+
867+
868+
<td class="description last">An object specifying whether results must match `all`, `any` or `none` of a given filter. Please refer to https://docs.constructor.com/reference/v1-search-get-search-results</td>
869+
</tr>
870+
871+
831872
</tbody>
832873
</table>
833874

@@ -992,7 +1033,7 @@ <h4 class="name" id="~getVoiceSearchResults"><span class="type-signature type-si
9921033

9931034
<dt class="tag-source">Source:</dt>
9941035
<dd class="tag-source"><ul class="dummy"><li>
995-
<a href="modules_search.js.html">modules/search.js</a>, <a href="modules_search.js.html#line229">line 229</a>
1036+
<a href="modules_search.js.html">modules/search.js</a>, <a href="modules_search.js.html#line237">line 237</a>
9961037
</li></ul></dd>
9971038

9981039

@@ -1709,7 +1750,7 @@ <h5 class="h5-returns">Returns:</h5>
17091750
<br class="clear">
17101751

17111752
<footer>
1712-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Dec 03 2024 19:21:33 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
1753+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Dec 03 2024 19:24:18 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
17131754
</footer>
17141755

17151756
<script>prettyPrint();</script>

‎docs/module-tracker.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -12637,7 +12637,7 @@ <h5 class="h5-returns">Returns:</h5>
1263712637
<br class="clear">
1263812638

1263912639
<footer>
12640-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Dec 03 2024 19:21:33 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
12640+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Dec 03 2024 19:24:18 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
1264112641
</footer>
1264212642

1264312643
<script>prettyPrint();</script>

‎docs/modules_assistant.js.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,7 @@ <h1 class="page-title">modules/assistant.js</h1>
245245
<br class="clear">
246246

247247
<footer>
248-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Dec 03 2024 19:21:33 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
248+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Dec 03 2024 19:24:18 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
249249
</footer>
250250

251251
<script>prettyPrint();</script>

‎docs/modules_autocomplete.js.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -276,7 +276,7 @@ <h1 class="page-title">modules/autocomplete.js</h1>
276276
<br class="clear">
277277

278278
<footer>
279-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Dec 03 2024 19:21:33 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
279+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Dec 03 2024 19:24:18 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
280280
</footer>
281281

282282
<script>prettyPrint();</script>

‎docs/modules_browse.js.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -593,7 +593,7 @@ <h1 class="page-title">modules/browse.js</h1>
593593
<br class="clear">
594594

595595
<footer>
596-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Dec 03 2024 19:21:33 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
596+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Dec 03 2024 19:24:18 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
597597
</footer>
598598

599599
<script>prettyPrint();</script>

‎docs/modules_quizzes.js.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -329,7 +329,7 @@ <h1 class="page-title">modules/quizzes.js</h1>
329329
<br class="clear">
330330

331331
<footer>
332-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Dec 03 2024 19:21:33 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
332+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Dec 03 2024 19:24:18 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
333333
</footer>
334334

335335
<script>prettyPrint();</script>

‎docs/modules_recommendations.js.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,7 @@ <h1 class="page-title">modules/recommendations.js</h1>
236236
<br class="clear">
237237

238238
<footer>
239-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Dec 03 2024 19:21:33 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
239+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Dec 03 2024 19:24:18 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
240240
</footer>
241241

242242
<script>prettyPrint();</script>

‎docs/modules_search.js.html

+10-2
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ <h1 class="page-title">modules/search.js</h1>
9494
}
9595

9696
if (parameters) {
97-
const { offset, page, resultsPerPage, filters, sortBy, sortOrder, section, fmtOptions, hiddenFields, hiddenFacets, variationsMap, qsParam, preFilterExpression } = parameters;
97+
const { offset, page, resultsPerPage, filters, sortBy, sortOrder, section, fmtOptions, hiddenFields, hiddenFacets, variationsMap, qsParam, preFilterExpression, filterMatchTypes } = parameters;
9898

9999
// Pull offset from parameters
100100
if (!helpers.isNil(offset)) {
@@ -116,6 +116,10 @@ <h1 class="page-title">modules/search.js</h1>
116116
queryParams.filters = filters;
117117
}
118118

119+
if (filterMatchTypes) {
120+
queryParams.filter_match_types = filterMatchTypes;
121+
}
122+
119123
// Pull sort by from parameters
120124
if (sortBy) {
121125
queryParams.sort_by = sortBy;
@@ -213,6 +217,7 @@ <h1 class="page-title">modules/search.js</h1>
213217
* @param {string[]} [parameters.hiddenFacets] - Hidden facets to return
214218
* @param {object} [parameters.variationsMap] - The variations map object to aggregate variations. Please refer to https://docs.constructor.com/reference/shared-variations-mapping for details
215219
* @param {object} [parameters.qsParam] - Parameters listed above can be serialized into a JSON object and parsed through this parameter. Please refer to https://docs.constructor.com/reference/v1-search-get-search-results
220+
* @param {object} [parameters.filterMatchTypes] - An object specifying whether results must match `all`, `any` or `none` of a given filter. Please refer to https://docs.constructor.com/reference/v1-search-get-search-results
216221
* @param {object} [networkParameters] - Parameters relevant to the network request
217222
* @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
218223
* @returns {Promise}
@@ -223,6 +228,9 @@ <h1 class="page-title">modules/search.js</h1>
223228
* filters: {
224229
* size: 'medium'
225230
* },
231+
* filterMatchTypes: {
232+
* size: 'all'
233+
* }
226234
* });
227235
*/
228236
getSearchResults(query, parameters, networkParameters = {}) {
@@ -365,7 +373,7 @@ <h1 class="page-title">modules/search.js</h1>
365373
<br class="clear">
366374

367375
<footer>
368-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Dec 03 2024 19:21:33 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
376+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Dec 03 2024 19:24:18 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
369377
</footer>
370378

371379
<script>prettyPrint();</script>

‎docs/modules_tracker.js.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -2845,7 +2845,7 @@ <h1 class="page-title">modules/tracker.js</h1>
28452845
<br class="clear">
28462846

28472847
<footer>
2848-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Dec 03 2024 19:21:33 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
2848+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Dec 03 2024 19:24:18 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
28492849
</footer>
28502850

28512851
<script>prettyPrint();</script>

‎package-lock.json

+2-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@constructor-io/constructorio-client-javascript",
3-
"version": "2.59.1",
3+
"version": "2.59.2",
44
"description": "Constructor.io JavaScript client",
55
"main": "lib/constructorio.js",
66
"types": "lib/types/index.d.ts",

‎src/version.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
export default '2.59.1';
1+
export default '2.59.2';

0 commit comments

Comments
 (0)