@constructor-io/constructorio-client-javascript 2.29.8 → 2.29.9

package/lib/modules/search.js

@@ -6,6 +6,8 @@ var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/cl
 
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
 
+/* eslint-disable complexity */
+
 /* eslint-disable max-len */
 
 /* eslint-disable object-curly-newline, no-underscore-dangle */
@@ -58,7 +60,8 @@ function createSearchUrl(query, parameters, options) {
   }
 
   if (parameters) {
-    var page = parameters.page,
+    var offset = parameters.offset,
+        page = parameters.page,
         resultsPerPage = parameters.resultsPerPage,
         filters = parameters.filters,
         sortBy = parameters.sortBy,
@@ -67,7 +70,14 @@ function createSearchUrl(query, parameters, options) {
         fmtOptions = parameters.fmtOptions,
         hiddenFields = parameters.hiddenFields,
         hiddenFacets = parameters.hiddenFacets,
-        variationsMap = parameters.variationsMap; // Pull page from parameters
+        variationsMap = parameters.variationsMap,
+        qsParam = parameters.qsParam,
+        preFilterExpression = parameters.preFilterExpression; // Pull offset from parameters
+
+    if (!helpers.isNil(offset)) {
+      queryParams.offset = offset;
+    } // Pull page from parameters
+
 
     if (!helpers.isNil(page)) {
       queryParams.page = page;
@@ -128,6 +138,16 @@ function createSearchUrl(query, parameters, options) {
 
     if (variationsMap) {
       queryParams.variations_map = JSON.stringify(variationsMap);
+    } // Pull pre_filter_expression from parameters
+
+
+    if (preFilterExpression) {
+      queryParams.pre_filter_expression = JSON.stringify(preFilterExpression);
+    } // pull qs param from parameters
+
+
+    if (qsParam) {
+      queryParams.qs = JSON.stringify(qsParam);
     }
   }
 
@@ -160,16 +180,19 @@ var Search = /*#__PURE__*/function () {
    * @description Retrieve search results from Constructor.io API
    * @param {string} query - Term to use to perform a search
    * @param {object} [parameters] - Additional parameters to refine result set
-   * @param {number} [parameters.page] - The page number of the results
+   * @param {number} [parameters.page] - The page number of the results(Can't be used together with offset)
+   * @param {number} [parameters.offset] - The number of results to skip from the beginning (Can't be used together with page)
    * @param {number} [parameters.resultsPerPage] - The number of results per page to return
    * @param {object} [parameters.filters] - Key / value mapping (dictionary) of filters used to refine results
    * @param {string} [parameters.sortBy='relevance'] - The sort method for results
    * @param {string} [parameters.sortOrder='descending'] - The sort order for results
    * @param {string} [parameters.section='Products'] - The section name for results
-   * @param {object} [parameters.fmtOptions] - The format options used to refine result groups
+   * @param {object} [parameters.fmtOptions] - The format options used to refine result groups. Please refer to https://docs.constructor.io/rest_api/search/queries for details
+   * @param {object} [parameters.preFilterExpression] - Faceting expression to scope search results. Please refer to https://docs.constructor.io/rest_api/collections#add-items-dynamically
    * @param {string[]} [parameters.hiddenFields] - Hidden metadata fields to return
    * @param {string[]} [parameters.hiddenFacets] - Hidden facets to return
    * @param {object} [parameters.variationsMap] - The variations map object to aggregate variations. Please refer to https://docs.constructor.io/rest_api/variations_mapping for details
+   * @param {object} [parameters.qs] - Parameters listed above can be serialized into a JSON object and parsed through this parameter. Please refer to https://docs.constructor.io/rest_api/search/queries/
    * @param {object} [networkParameters] - Parameters relevant to the network request
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@constructor-io/constructorio-client-javascript",
-  "version": "2.29.8",
+  "version": "2.29.9",
   "description": "Constructor.io JavaScript client",
   "main": "lib/constructorio.js",
   "scripts": {