@constructor-io/constructorio-client-javascript 2.53.1 → 2.55.0

package/lib/modules/autocomplete.js

@@ -58,7 +58,8 @@ function createAutocompleteUrl(query, parameters, options) {
       filtersPerSection = parameters.filtersPerSection,
       hiddenFields = parameters.hiddenFields,
       variationsMap = parameters.variationsMap,
-      preFilterExpression = parameters.preFilterExpression;
+      preFilterExpression = parameters.preFilterExpression,
+      qsParam = parameters.qsParam;
 
     // Pull results number from parameters
     if (numResults) {
@@ -104,6 +105,11 @@ function createAutocompleteUrl(query, parameters, options) {
     if (variationsMap) {
       queryParams.variations_map = JSON.stringify(variationsMap);
     }
+
+    // pull qs param from parameters
+    if (qsParam) {
+      queryParams.qs = JSON.stringify(qsParam);
+    }
   }
   queryParams._dt = Date.now();
   queryParams = cleanParams(queryParams);
@@ -141,6 +147,7 @@ var Autocomplete = /*#__PURE__*/function () {
    * @param {object} [parameters.preFilterExpression] - Faceting expression to scope autocomplete results. Please refer to https://docs.constructor.io/rest_api/collections/#add-items-dynamically for details
    * @param {string[]} [parameters.hiddenFields] - Hidden metadata fields 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.qsParam] - object of additional query parameters to be appended to requests for results
    * @param {object} [networkParameters] - Parameters relevant to the network request
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}

package/lib/modules/tracker.js

@@ -7,6 +7,7 @@ var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/cl
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) { symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }
 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, camelcase, no-unneeded-ternary */
 var EventEmitter = require('../utils/events');
 var helpers = require('../utils/helpers');
@@ -277,7 +278,7 @@ var Tracker = /*#__PURE__*/function () {
      * @param {string} [parameters.tr] - Trigger used to select the item (click, etc.)
      * @param {string} [parameters.itemId] - Item id of the selected item
      * @param {string} [parameters.variationId] - Variation id of the selected item
-     * @param {string} [parameters.groupId] - Group identifier of selected item
+     * @param {string} [parameters.groupId] - Group identifier of the group to search within. Only required if searching within a group, i.e. "Pumpkin in Canned Goods"
      * @param {object} [networkParameters] - Parameters relevant to the network request
      * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
      * @returns {(true|Error)}
@@ -361,7 +362,7 @@ var Tracker = /*#__PURE__*/function () {
      * @param {string} parameters.originalQuery - The current autocomplete search query
      * @param {string} parameters.section - Section the selected item resides within
      * @param {string} [parameters.tr] - Trigger used to select the item (click, etc.)
-     * @param {string} [parameters.groupId] - Group identifier of selected item
+     * @param {string} [parameters.groupId] - Group identifier of the group to search within. Only required if searching within a group, i.e. "Pumpkin in Canned Goods"
      * @param {string} [parameters.displayName] - Display name of group of selected item
      * @param {object} [networkParameters] - Parameters relevant to the network request
      * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
@@ -436,7 +437,7 @@ var Tracker = /*#__PURE__*/function () {
      * @param {string} searchTerm - Term of submitted autocomplete event
      * @param {object} parameters - Additional parameters to be sent with request
      * @param {string} parameters.userInput - The current autocomplete search query
-     * @param {string} [parameters.groupId] - Group identifier of selected item
+     * @param {string} [parameters.groupId] - Group identifier of the group to search within. Only required if searching within a group, i.e. "Pumpkin in Canned Goods"
      * @param {string} [parameters.section] - The section name for the item Ex. "Products"
      * @param {object} [parameters.analyticsTags] - Pass additional analytics data
      * @param {object} [networkParameters] - Parameters relevant to the network request
@@ -513,7 +514,7 @@ var Tracker = /*#__PURE__*/function () {
      * @param {string} term - Term of submitted autocomplete event
      * @param {object} parameters - Additional parameters to be sent with request
      * @param {string} parameters.originalQuery - The current autocomplete search query
-     * @param {string} [parameters.groupId] - Group identifier of selected item
+     * @param {string} [parameters.groupId] - Group identifier of the group to search within. Only required if searching within a group, i.e. "Pumpkin in Canned Goods"
      * @param {string} [parameters.displayName] - Display name of group of selected item
      * @param {object} [networkParameters] - Parameters relevant to the network request
      * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)

package/lib/types/autocomplete.d.ts

@@ -19,6 +19,7 @@ export interface IAutocompleteParameters {
   hiddenFields?: string[];
   variationsMap?: VariationsMap;
   preFilterExpression?: FilterExpression;
+  qsParam?: Record<string, any>;
 }
 
 declare class Autocomplete {

package/lib/utils/store.js

@@ -1,5 +1,19 @@
 "use strict";
 
+function canUseStorage(type) {
+  var storage;
+  try {
+    storage = window[type];
+    var x = '__storage_test__';
+    storage.setItem(x, x);
+    storage.removeItem(x);
+    return true;
+  } catch (e) {
+    return e instanceof DOMException && e.name === 'QuotaExceededError'
+    // acknowledge QuotaExceededError only if there's something already stored
+    && storage && storage.length !== 0;
+  }
+}
 var session = {
   overflow: {},
   get: function get(key) {
@@ -8,7 +22,7 @@ var session = {
     if (valueFromOverflow) {
       return valueFromOverflow;
     }
-    if (typeof sessionStorage === 'undefined') {
+    if (!canUseStorage('sessionStorage') || typeof sessionStorage === 'undefined') {
       return null;
     }
     var valueFromSession = sessionStorage.getItem(key);
@@ -35,13 +49,13 @@ var session = {
     if ((_this$overflow = this.overflow) !== null && _this$overflow !== void 0 && _this$overflow[key]) {
       delete this.overflow[key];
     }
-    if (typeof sessionStorage !== 'undefined') {
+    if (canUseStorage('sessionStorage') || typeof sessionStorage !== 'undefined') {
       sessionStorage.removeItem(key);
     }
   },
   key: function key(i) {
     var _sessionStorage, _sessionStorage2;
-    if (typeof sessionStorage === 'undefined') {
+    if (!canUseStorage('sessionStorage') || typeof sessionStorage === 'undefined') {
       var _Object$keys;
       return (_Object$keys = Object.keys(this.overflow)) === null || _Object$keys === void 0 ? void 0 : _Object$keys[i];
     }
@@ -56,14 +70,14 @@ var session = {
   },
   length: function length() {
     var overflowLength = Object.keys(this.overflow).length;
-    if (typeof sessionStorage === 'undefined') {
+    if (!canUseStorage('sessionStorage') || typeof sessionStorage === 'undefined') {
       return overflowLength;
     }
     return sessionStorage.length + overflowLength;
   },
   clear: function clear() {
     this.overflow = {};
-    if (typeof sessionStorage !== 'undefined') {
+    if (canUseStorage('sessionStorage') || typeof sessionStorage !== 'undefined') {
       sessionStorage.clear();
     }
   }
@@ -76,7 +90,7 @@ var local = {
     if (valueFromOverflow) {
       return valueFromOverflow;
     }
-    if (typeof localStorage === 'undefined') {
+    if (!canUseStorage('localStorage') || typeof localStorage === 'undefined') {
       return null;
     }
     var valueFromLocal = localStorage.getItem(key);
@@ -103,13 +117,13 @@ var local = {
     if ((_this$overflow2 = this.overflow) !== null && _this$overflow2 !== void 0 && _this$overflow2[key]) {
       delete this.overflow[key];
     }
-    if (typeof localStorage !== 'undefined') {
+    if (canUseStorage('localStorage') || typeof localStorage !== 'undefined') {
       localStorage.removeItem(key);
     }
   },
   key: function key(i) {
     var _localStorage, _localStorage2;
-    if (typeof localStorage === 'undefined') {
+    if (!canUseStorage('localStorage') || typeof localStorage === 'undefined') {
       var _Object$keys3;
       return (_Object$keys3 = Object.keys(this.overflow)) === null || _Object$keys3 === void 0 ? void 0 : _Object$keys3[i];
     }
@@ -124,20 +138,21 @@ var local = {
   },
   length: function length() {
     var overflowLength = Object.keys(this.overflow).length;
-    if (typeof localStorage === 'undefined') {
+    if (!canUseStorage('localStorage') || typeof localStorage === 'undefined') {
       return overflowLength;
     }
     return localStorage.length + overflowLength;
   },
   clear: function clear() {
     this.overflow = {};
-    if (typeof localStorage !== 'undefined') {
+    if (canUseStorage('localStorage') || typeof localStorage !== 'undefined') {
       localStorage.clear();
     }
   }
 };
 var store = {
   local: local,
-  session: session
+  session: session,
+  canUseStorage: canUseStorage
 };
 module.exports = store;

package/lib/version.js

@@ -4,5 +4,5 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-var _default = '2.53.1';
+var _default = '2.55.0';
 exports["default"] = _default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@constructor-io/constructorio-client-javascript",
-  "version": "2.53.1",
+  "version": "2.55.0",
   "description": "Constructor.io JavaScript client",
   "main": "lib/constructorio.js",
   "types": "lib/types/index.d.ts",
@@ -10,13 +10,14 @@
     "check-license": "license-checker --production --onlyAllow 'Apache-2.0;BSD-3-Clause;MIT;0BSD;BSD-2-Clause'",
     "verify-node-version": "chmod +x ./scripts/verify-node-version.sh && ./scripts/verify-node-version.sh",
     "lint": "eslint 'src/**/*.js' 'spec/**/*.js' 'src/**/*.d.ts'",
-    "test": "npm run compile && mkdir -p test && cp -rf lib/* test && mocha --retries 3 ./spec/*",
+    "pretest": "npm run compile && npm run generate-test-folder",
+    "test": "mocha --retries 3 ./spec/*",
     "test:types": "tsd .",
-    "test:parallel": "npm run compile && mkdir -p test && cp -rf lib/* test && mocha --parallel --retries 3 ./spec/*",
+    "test:parallel": "npm run pretest && mocha --parallel --retries 3 ./spec/*",
     "test:src": "mkdir -p test && cp -rf src/* test && mocha --retries 3 ./spec/*",
     "test:src:parallel": "mkdir -p test && cp -rf src/* test && mocha --parallel --retries 3 ./spec/*",
-    "test:bundled": "npm run bundle && BUNDLED=true PACKAGE_VERSION=$(echo $npm_package_version) mocha --retries 3 ./spec/*",
-    "test:bundled:parallel": "npm run bundle && BUNDLED=true PACKAGE_VERSION=$(echo $npm_package_version) mocha --parallel --retries 3 ./spec/*",
+    "test:bundled": "npm run bundle && npm run generate-test-folder && BUNDLED=true PACKAGE_VERSION=$(echo $npm_package_version) mocha --retries 3 ./spec/*",
+    "test:bundled:parallel": "npm run bundle && npm run generate-test-folder && BUNDLED=true PACKAGE_VERSION=$(echo $npm_package_version) mocha --parallel --retries 3 ./spec/*",
     "test:all": "npm run test && npm run test:bundled",
     "test:all:parallel": "npm run test:parallel && npm run test:bundled:parallel",
     "precoverage": "rm -rf ./coverage && rm -rf ./.nyc_output",
@@ -26,7 +27,8 @@
     "compile": "rm -rf ./lib/* && babel src/ -d lib/ --copy-files && rm -rf ./lib/types/tests",
     "prepublish": "npm run compile",
     "bundle": "rm -rf ./dist/* && npm run compile && node bundle.js",
-    "prepare": "husky install"
+    "prepare": "husky install",
+    "generate-test-folder": "mkdir -p test && cp -rf lib/* test"
   },
   "repository": {
     "type": "git",
@@ -73,7 +75,7 @@
     "web-streams-polyfill": "^4.0.0"
   },
   "dependencies": {
-    "@constructor-io/constructorio-id": "^2.4.17",
+    "@constructor-io/constructorio-id": "^2.6.0",
     "crc-32": "^1.2.2"
   },
   "peerDependencies": {