@constructor-io/constructorio-node 3.10.0 → 3.10.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@constructor-io/constructorio-node",
-  "version": "3.10.0",
+  "version": "3.10.1",
   "description": "Constructor.io Node.js client",
   "main": "src/constructorio.js",
   "scripts": {

package/src/modules/browse.js

@@ -1,3 +1,4 @@
+/* eslint-disable max-len */
 /* eslint-disable object-curly-newline, no-underscore-dangle, max-params */
 const qs = require('qs');
 const nodeFetch = require('node-fetch').default;
@@ -26,6 +27,7 @@ function createQueryParams(parameters, userParameters, options) {
   if (parameters) {
     const {
       page,
+      offset,
       resultsPerPage,
       filters,
       sortBy,
@@ -42,6 +44,11 @@ function createQueryParams(parameters, userParameters, options) {
       queryParams.page = page;
     }
 
+    // Pull offset from parameters
+    if (!helpers.isNil(offset)) {
+      queryParams.offset = offset;
+    }
+
     // Pull results per page from parameters
     if (!helpers.isNil(resultsPerPage)) {
       queryParams.num_results_per_page = resultsPerPage;
@@ -226,7 +233,8 @@ class Browse {
    * @param {string} filterName - Filter name to display results from
    * @param {string} filterValue - Filter value to display results from
    * @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] - Filters used to refine results
    * @param {string} [parameters.sortBy='relevance'] - The sort method for results
@@ -310,7 +318,8 @@ class Browse {
    * @function getBrowseResultsForItemIds
    * @param {string[]} itemIds - Item IDs of results to fetch
    * @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] - Filters used to refine results
    * @param {string} [parameters.sortBy='relevance'] - The sort method for results
@@ -445,7 +454,8 @@ class Browse {
    *
    * @function getBrowseFacets
    * @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 {string} [parameters.section='Products'] - The section name for results
    * @param {number} [parameters.resultsPerPage] - The number of results per page to return
    * @param {object} [parameters.fmtOptions] - The format options used to refine result groups

package/src/modules/search.js

@@ -1,3 +1,4 @@
+/* eslint-disable max-len */
 /* eslint-disable object-curly-newline, no-underscore-dangle */
 const qs = require('qs');
 const nodeFetch = require('node-fetch').default;
@@ -5,6 +6,7 @@ const { AbortController } = require('node-abort-controller');
 const helpers = require('../utils/helpers');
 
 // Create URL from supplied query (term) and parameters
+// eslint-disable-next-line complexity
 function createSearchUrl(query, parameters, userParameters, options) {
   const {
     apiKey,
@@ -49,6 +51,7 @@ function createSearchUrl(query, parameters, userParameters, options) {
   if (parameters) {
     const {
       page,
+      offset,
       resultsPerPage,
       filters,
       sortBy,
@@ -65,6 +68,11 @@ function createSearchUrl(query, parameters, userParameters, options) {
       queryParams.page = page;
     }
 
+    // Pull offset from parameters
+    if (!helpers.isNil(offset)) {
+      queryParams.offset = offset;
+    }
+
     // Pull results per page from parameters
     if (!helpers.isNil(resultsPerPage)) {
       queryParams.num_results_per_page = resultsPerPage;
@@ -145,7 +153,8 @@ class Search {
    * @function getSearchResults
    * @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] - Filters used to refine search
    * @param {string} [parameters.sortBy='relevance'] - The sort method for results