@constructor-io/constructorio-client-javascript 2.21.0 → 2.25.2

package/README.md

@@ -3,14 +3,19 @@
 [![npm](https://img.shields.io/npm/v/@constructor-io/constructorio-client-javascript)](https://www.npmjs.com/package/@constructor-io/constructorio-client-javascript)
 [![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/Constructor-io/constructorio-client-javascript/blob/master/LICENSE)
 [![Minzipped Size](https://img.shields.io/bundlephobia/minzip/@constructor-io/constructorio-client-javascript)](https://bundlephobia.com/result?p=@constructor-io/constructorio-client-javascript)
-[![Dependencies](https://img.shields.io/david/Constructor-io/constructorio-client-javascript)](https://david-dm.org/constructor-io/constructorio-client-javascript)
 
 A JavaScript client for [Constructor.io](http://constructor.io/). [Constructor.io](http://constructor.io/) provides search as a service that optimizes results using artificial intelligence (including natural language processing, re-ranking to optimize for conversions, and user personalization).
 
+> 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) 
+
 ## 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.
 
+Alternatively, a bundled version consisting of a single JavaScript file is published within the `./dist` folder on Github. This can be utilized within a browser context if hosted locally - _please do not link directly to the Github hosted version_.
+
+**Important**: this library should only be used in a client-side context where standard HTTP request headers are populated by the client (`User-Agent`, `Referer`, etc.).
+
 ## 2. Retrieve an API key
 
 You can find this in your [Constructor.io dashboard](https://constructor.io/dashboard). Contact sales if you'd like to sign up, or support if you believe your company already has an account.

package/lib/constructorio.js

@@ -1,10 +1,10 @@
 "use strict";
 
-function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 
-function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 
-function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; }
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
 
 /* eslint-disable camelcase, no-unneeded-ternary, max-len */
 var ConstructorioID = require('@constructor-io/constructorio-id'); // Modules
@@ -33,35 +33,34 @@ var _require = require('../package.json'),
 
 var ConstructorIO = /*#__PURE__*/function () {
   /**
-   * @param {string} apiKey - Constructor.io API key
-   * @param {string} [serviceUrl='https://ac.cnstrc.com'] - API URL endpoint
-   * @param {array} [segments] - User segments
-   * @param {object} [testCells] - User test cells
-   * @param {string} [clientId] - Client ID, defaults to value supplied by 'constructorio-id' module
-   * @param {string} [sessionId] - Session ID, defaults to value supplied by 'constructorio-id' module
-   * @param {string} [userId] - User ID
-   * @param {function} [fetch] - If supplied, will be utilized for requests rather than default Fetch API
-   * @param {number} [trackingSendDelay=250] - Amount of time to wait before sending tracking events (in ms)
-   * @param {boolean} [sendReferrerWithTrackingEvents=true] - Indicates if the referrer is sent with tracking events
-   * @param {boolean} [sendTrackingEvents=false] - Indicates if tracking events should be dispatched
-   * @param {object} [idOptions] - Options object to be supplied to 'constructorio-id' module
-   * @param {object} [eventDispatcher] - Options related to 'EventDispatcher' class
-   * @param {boolean} [eventDispatcher.enabled=true] - Determine if events should be dispatched
-   * @param {boolean} [eventDispatcher.waitForBeacon=true] - Wait for beacon before dispatching events
-   * @param {object} [networkParameters] - Parameters relevant to network requests
-   * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds) - may be overridden within individual method calls
-   * @property {object} [search] - Interface to {@link module:search}
-   * @property {object} [browse] - Interface to {@link module:browse}
-   * @property {object} [autocomplete] - Interface to {@link module:autocomplete}
-   * @property {object} [recommendations] - Interface to {@link module:recommendations}
-   * @property {object} [tracker] - Interface to {@link module:tracker}
+   * @param {object} parameters - Parameters for client instantiation
+   * @param {string} parameters.apiKey - Constructor.io API key
+   * @param {string} [parameters.serviceUrl='https://ac.cnstrc.com'] - API URL endpoint
+   * @param {array} [parameters.segments] - User segments
+   * @param {object} [parameters.testCells] - User test cells
+   * @param {string} [parameters.clientId] - Client ID, defaults to value supplied by 'constructorio-id' module
+   * @param {string} [parameters.sessionId] - Session ID, defaults to value supplied by 'constructorio-id' module
+   * @param {string} [parameters.userId] - User ID
+   * @param {function} [parameters.fetch] - If supplied, will be utilized for requests rather than default Fetch API
+   * @param {number} [parameters.trackingSendDelay=250] - Amount of time to wait before sending tracking events (in ms)
+   * @param {boolean} [parameters.sendReferrerWithTrackingEvents=true] - Indicates if the referrer is sent with tracking events
+   * @param {boolean} [parameters.sendTrackingEvents=false] - Indicates if tracking events should be dispatched
+   * @param {object} [parameters.idOptions] - Options object to be supplied to 'constructorio-id' module
+   * @param {object} [parameters.eventDispatcher] - Options related to 'EventDispatcher' class
+   * @param {boolean} [parameters.eventDispatcher.enabled=true] - Determine if events should be dispatched
+   * @param {boolean} [parameters.eventDispatcher.waitForBeacon=true] - Wait for beacon before dispatching events
+   * @param {object} [parameters.networkParameters] - Parameters relevant to network requests
+   * @param {number} [parameters.networkParameters.timeout] - Request timeout (in milliseconds) - may be overridden within individual method calls
+   * @property {object} search - Interface to {@link module:search}
+   * @property {object} browse - Interface to {@link module:browse}
+   * @property {object} autocomplete - Interface to {@link module:autocomplete}
+   * @property {object} recommendations - Interface to {@link module:recommendations}
+   * @property {object} tracker - Interface to {@link module:tracker}
    * @returns {class}
    */
   function ConstructorIO() {
     var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-
-    _classCallCheck(this, ConstructorIO);
-
+    (0, _classCallCheck2["default"])(this, ConstructorIO);
     var canUseDOM = helpers.canUseDOM();
     var apiKey = options.apiKey,
         version = options.version,
@@ -106,8 +105,8 @@ var ConstructorIO = /*#__PURE__*/function () {
 
     this.options = {
       apiKey: apiKey,
-      version: version || global.CLIENT_VERSION || "ciojs-client-".concat(canUseDOM ? '' : 'domless-').concat(packageVersion),
-      serviceUrl: serviceUrl || 'https://ac.cnstrc.com',
+      version: version || typeof global !== 'undefined' && global.CLIENT_VERSION || "ciojs-client-".concat(canUseDOM ? '' : 'domless-').concat(process.env.BUNDLED ? 'bundled-' : '').concat(packageVersion),
+      serviceUrl: serviceUrl && serviceUrl.replace(/\/$/, '') || 'https://ac.cnstrc.com',
       sessionId: sessionId || session_id,
       clientId: clientId || client_id,
       userId: userId,
@@ -141,7 +140,7 @@ var ConstructorIO = /*#__PURE__*/function () {
    */
 
 
-  _createClass(ConstructorIO, [{
+  (0, _createClass2["default"])(ConstructorIO, [{
     key: "setClientOptions",
     value: function setClientOptions(options) {
       if (Object.keys(options).length) {
@@ -168,8 +167,14 @@ var ConstructorIO = /*#__PURE__*/function () {
       }
     }
   }]);
-
   return ConstructorIO;
-}();
+}(); // Exposed for testing
+
+
+ConstructorIO.Tracker = Tracker; // Expose on window object if available
+
+if (helpers.canUseDOM()) {
+  window.ConstructorioClient = ConstructorIO;
+}
 
 module.exports = ConstructorIO;

package/lib/modules/autocomplete.js

@@ -1,10 +1,10 @@
 "use strict";
 
-function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 
-function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 
-function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; }
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
 
 /* eslint-disable object-curly-newline, no-underscore-dangle */
 var qs = require('qs');
@@ -104,8 +104,7 @@ function createAutocompleteUrl(query, parameters, options) {
 
 var Autocomplete = /*#__PURE__*/function () {
   function Autocomplete(options) {
-    _classCallCheck(this, Autocomplete);
-
+    (0, _classCallCheck2["default"])(this, Autocomplete);
     this.options = options || {};
     this.eventDispatcher = new EventDispatcher(options.eventDispatcher);
   }
@@ -137,7 +136,7 @@ var Autocomplete = /*#__PURE__*/function () {
    */
 
 
-  _createClass(Autocomplete, [{
+  (0, _createClass2["default"])(Autocomplete, [{
     key: "getAutocompleteResults",
     value: function getAutocompleteResults(query, parameters) {
       var _this = this;
@@ -192,7 +191,6 @@ var Autocomplete = /*#__PURE__*/function () {
       });
     }
   }]);
-
   return Autocomplete;
 }();
 

package/lib/modules/browse.js

@@ -1,16 +1,16 @@
 "use strict";
 
-function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 
-function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 
-function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; }
+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; }
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 
-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) { _defineProperty(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; }
+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 _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+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 object-curly-newline, no-underscore-dangle */
 var qs = require('qs');
@@ -133,7 +133,7 @@ function createBrowseUrlFromFilter(filterName, filterValue, parameters, options)
 function createBrowseUrlFromIDs(ids, parameters, options) {
   var serviceUrl = options.serviceUrl; // Validate id's are provided
 
-  if (!ids || !(ids instanceof Array) || !ids.length) {
+  if (!ids || !Array.isArray(ids) || !ids.length) {
     throw new Error('ids is a required parameter of type array');
   }
 
@@ -173,8 +173,7 @@ function createBrowseUrlForFacets(parameters, options) {
 
 var Browse = /*#__PURE__*/function () {
   function Browse(options) {
-    _classCallCheck(this, Browse);
-
+    (0, _classCallCheck2["default"])(this, Browse);
     this.options = options || {};
     this.eventDispatcher = new EventDispatcher(options.eventDispatcher);
   }
@@ -196,7 +195,7 @@ var Browse = /*#__PURE__*/function () {
    * @param {object} [networkParameters] - Parameters relevant to the network request
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
-   * @see https://docs.constructor.io/rest_api/browse/
+   * @see https://docs.constructor.io/rest_api/browse/results
    * @example
    * constructorio.browse.getBrowseResults('group_id', 't-shirts', {
    *     resultsPerPage: 40,
@@ -207,7 +206,7 @@ var Browse = /*#__PURE__*/function () {
    */
 
 
-  _createClass(Browse, [{
+  (0, _createClass2["default"])(Browse, [{
     key: "getBrowseResults",
     value: function getBrowseResults(filterName, filterValue, parameters) {
       var _this = this;
@@ -334,13 +333,13 @@ var Browse = /*#__PURE__*/function () {
      * @param {object} [networkParameters] - Parameters relevant to the network request
      * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
      * @returns {Promise}
-     * @see https://docs.constructor.io/rest-api.html#browse-groups
+     * @see https://docs.constructor.io/rest_api/browse/groups
      * @example
      * constructorio.browse.getBrowseGroups({
      *     filters: {
      *         group_id: 'drill_collection'
      *     },
-     *     fmt_options: {
+     *     fmtOptions: {
      *         groups_max_depth: 2
      *     }
      * });
@@ -391,6 +390,8 @@ var Browse = /*#__PURE__*/function () {
      * @param {object} [parameters] - Additional parameters to refine result set
      * @param {number} [parameters.page] - The page number of the results
      * @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)
      * @returns {Promise}
      * @see https://docs.constructor.io/rest_api/browse/facets
      * @example
@@ -402,21 +403,27 @@ var Browse = /*#__PURE__*/function () {
 
   }, {
     key: "getBrowseFacets",
-    value: function getBrowseFacets(parameters) {
+    value: function getBrowseFacets(parameters, networkParameters) {
       var _this4 = this;
 
       var requestUrl;
       var fetch = this.options && this.options.fetch || fetchPonyfill({
         Promise: Promise
       }).fetch;
+      var controller = new AbortController();
+      var signal = controller.signal;
 
       try {
         requestUrl = createBrowseUrlForFacets(parameters, this.options);
       } catch (e) {
         return Promise.reject(e);
-      }
+      } // Handle network timeout if specified
+
 
-      return fetch(requestUrl).then(function (response) {
+      helpers.applyNetworkTimeout(this.options, networkParameters, controller);
+      return fetch(requestUrl, {
+        signal: signal
+      }).then(function (response) {
         if (response.ok) {
           return response.json();
         }
@@ -433,7 +440,6 @@ var Browse = /*#__PURE__*/function () {
       });
     }
   }]);
-
   return Browse;
 }();
 

package/lib/modules/recommendations.js

@@ -1,10 +1,10 @@
 "use strict";
 
-function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 
-function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 
-function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; }
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
 
 /* eslint-disable object-curly-newline, no-param-reassign */
 var qs = require('qs');
@@ -96,8 +96,7 @@ function createRecommendationsUrl(podId, parameters, options) {
 
 var Recommendations = /*#__PURE__*/function () {
   function Recommendations(options) {
-    _classCallCheck(this, Recommendations);
-
+    (0, _classCallCheck2["default"])(this, Recommendations);
     this.options = options || {};
     this.eventDispatcher = new EventDispatcher(options.eventDispatcher);
   }
@@ -127,7 +126,7 @@ var Recommendations = /*#__PURE__*/function () {
    */
 
 
-  _createClass(Recommendations, [{
+  (0, _createClass2["default"])(Recommendations, [{
     key: "getRecommendations",
     value: function getRecommendations(podId, parameters) {
       var _this = this;
@@ -175,7 +174,6 @@ var Recommendations = /*#__PURE__*/function () {
       });
     }
   }]);
-
   return Recommendations;
 }();
 

package/lib/modules/search.js

@@ -1,10 +1,10 @@
 "use strict";
 
-function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 
-function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 
-function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; }
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
 
 /* eslint-disable object-curly-newline, no-underscore-dangle */
 var qs = require('qs');
@@ -123,8 +123,7 @@ function createSearchUrl(query, parameters, options) {
 
 var Search = /*#__PURE__*/function () {
   function Search(options) {
-    _classCallCheck(this, Search);
-
+    (0, _classCallCheck2["default"])(this, Search);
     this.options = options || {};
     this.eventDispatcher = new EventDispatcher(options.eventDispatcher);
   }
@@ -140,6 +139,7 @@ var Search = /*#__PURE__*/function () {
    * @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 {string[]} [parameters.hiddenFields] - Hidden metadata fields to return
    * @param {object} [networkParameters] - Parameters relevant to the network request
@@ -156,7 +156,7 @@ var Search = /*#__PURE__*/function () {
    */
 
 
-  _createClass(Search, [{
+  (0, _createClass2["default"])(Search, [{
     key: "getSearchResults",
     value: function getSearchResults(query, parameters) {
       var _this = this;
@@ -211,7 +211,6 @@ var Search = /*#__PURE__*/function () {
       });
     }
   }]);
-
   return Search;
 }();