@constructor-io/constructorio-client-javascript 2.29.7 → 2.29.10

package/README.md

@@ -8,6 +8,9 @@ A JavaScript client for [Constructor.io](http://constructor.io/). [Constructor.i
 
 > This client is intended for use in a browser environment but can also be used in React Native based mobile applications.  Additional information about utilization in a React Native context can be found on the [Wiki](https://github.com/Constructor-io/constructorio-client-javascript/wiki/Utilization-in-a-DOM-less-environment).  If you want a JavaScript client for server side integrations please use [@constructor-io/constructorio-node](https://github.com/Constructor-io/constructorio-node) 
 
+## Documentation
+Full API documentation is available on [Github Pages](https://constructor-io.github.io/constructorio-client-javascript/index.html)
+
 ## 1. Install
 
 This package can be installed via npm: `npm i @constructor-io/constructorio-client-javascript`. Once installed, simply import or require the package into your repository.
@@ -45,8 +48,6 @@ window.addEventListener('cio.client.search.getSearchResults.completed', (event)
 }, false);
 ```
 
-Full API documentation is available on [Github Pages](https://constructor-io.github.io/constructorio-client-javascript/index.html)
-
 ## Development / npm commands
 
 ```bash

package/lib/modules/browse.js

@@ -12,9 +12,7 @@ function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (O
 
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { (0, _defineProperty2["default"])(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
 
-/* eslint-disable max-len */
-
-/* eslint-disable object-curly-newline, no-underscore-dangle */
+/* eslint-disable object-curly-newline, no-underscore-dangle, max-len, complexity */
 var qs = require('qs');
 
 var fetchPonyfill = require('fetch-ponyfill');
@@ -59,6 +57,7 @@ function createQueryParams(parameters, options) {
 
   if (parameters) {
     var page = parameters.page,
+        offset = parameters.offset,
         resultsPerPage = parameters.resultsPerPage,
         filters = parameters.filters,
         sortBy = parameters.sortBy,
@@ -67,10 +66,17 @@ function createQueryParams(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 page from parameters
 
     if (!helpers.isNil(page)) {
       queryParams.page = page;
+    } // Pull offset from parameters
+
+
+    if (!helpers.isNil(offset)) {
+      queryParams.offset = offset;
     } // Pull results per page from parameters
 
 
@@ -127,6 +133,16 @@ function createQueryParams(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);
     }
   }
 
@@ -228,16 +244,19 @@ var Browse = /*#__PURE__*/function () {
    * @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] - 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/browse/queries/ for details
+   * @param {object} [parameters.preFilterExpression] - Faceting expression to scope browse 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/browse/queries/
    * @param {object} [networkParameters] - Parameters relevant to the network request
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
@@ -309,13 +328,14 @@ var Browse = /*#__PURE__*/function () {
      * @function getBrowseResultsForItemIds
      * @param {string[]} itemIds - Item id's 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
      * @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/browse/queries/ for details
      * @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
@@ -388,7 +408,7 @@ var Browse = /*#__PURE__*/function () {
      * @function getBrowseGroups
      * @param {object} [parameters.filters] - Filters used to refine 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/browse/groups/ for details
      * @param {object} [networkParameters] - Parameters relevant to the network request
      * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
      * @returns {Promise}
@@ -452,9 +472,10 @@ var Browse = /*#__PURE__*/function () {
      *
      * @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 {boolean} [parameters.fmtOptions.show_hidden_facets] - Include facets configured as hidden
+     * @param {object} [parameters.fmtOptions] - The format options used to refine result groups. Please refer to https://docs.constructor.io/rest_api/browse/facets/ for details
      * @param {number} [parameters.resultsPerPage] - The number of results per page to return
      * @param {object} [networkParameters] - Parameters relevant to the network request
      * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
@@ -518,8 +539,7 @@ var Browse = /*#__PURE__*/function () {
      * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
      * @param {object} [parameters] - Additional parameters to refine result set
      * @param {string} [parameters.section='Products'] - The section name for results
-     * @param {object} [parameters.fmtOptions] - The format options used to refine result groups
-     * @param {boolean} [parameters.fmtOptions.show_hidden_facets] - Include facets configured as hidden
+     * @param {object} [parameters.fmtOptions] - The format options used to refine result groups. Please refer to https://docs.constructor.io/rest_api/browse/facet_options/ for details
      * @param {}
      * @returns {Promise}
      * @see https://docs.constructor.io/rest_api/browse/facet_options/

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/lib/utils/helpers.js

@@ -1,9 +1,5 @@
 "use strict";
 
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
-var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-
 /* eslint-disable no-param-reassign */
 var CRC32 = require('crc-32');
 
@@ -100,13 +96,13 @@ var utils = {
   },
   hasOrderIdRecord: function hasOrderIdRecord(orderId) {
     var orderIdHash = CRC32.str(orderId.toString());
-    var purchaseEventStorage = store.session.get(purchaseEventStorageKey);
+    var purchaseEventStorage = store.local.get(purchaseEventStorageKey);
 
     if (typeof purchaseEventStorage === 'string') {
       purchaseEventStorage = JSON.parse(purchaseEventStorage);
     }
 
-    if (purchaseEventStorage && purchaseEventStorage[orderIdHash]) {
+    if (purchaseEventStorage && purchaseEventStorage.includes(orderIdHash)) {
       return true;
     }
 
@@ -114,7 +110,7 @@ var utils = {
   },
   addOrderIdRecord: function addOrderIdRecord(orderId) {
     var orderIdHash = CRC32.str(orderId.toString());
-    var purchaseEventStorage = store.session.get(purchaseEventStorageKey);
+    var purchaseEventStorage = store.local.get(purchaseEventStorageKey);
 
     if (typeof purchaseEventStorage === 'string') {
       purchaseEventStorage = JSON.parse(purchaseEventStorage);
@@ -122,18 +118,22 @@ var utils = {
 
     if (purchaseEventStorage) {
       // If the order already exists, do nothing
-      if (purchaseEventStorage[orderIdHash]) {
+      if (purchaseEventStorage.includes(orderIdHash)) {
         return;
       }
 
-      purchaseEventStorage[orderIdHash] = true;
+      if (purchaseEventStorage.length >= 10) {
+        purchaseEventStorage = purchaseEventStorage.slice(-9);
+      }
+
+      purchaseEventStorage.push(orderIdHash);
     } else {
       // Create a new object map for the order ids
-      purchaseEventStorage = (0, _defineProperty2["default"])({}, orderIdHash, true);
-    } // Push the order id map into session storage
+      purchaseEventStorage = [orderIdHash];
+    } // Push the order id map into local storage
 
 
-    store.session.set(purchaseEventStorageKey, JSON.stringify(purchaseEventStorage));
+    store.local.set(purchaseEventStorageKey, JSON.stringify(purchaseEventStorage));
   },
   // Abort network request based on supplied timeout interval (in milliseconds)
   // - method call parameter takes precedence over global options parameter

package/package.json

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