@constructor-io/constructorio-client-javascript 2.37.0 → 2.37.1

package/lib/constructorio.js

@@ -1,56 +1,40 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
-
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
-
 /* eslint-disable camelcase, no-unneeded-ternary, max-len, complexity */
 var ConstructorioID = require('@constructor-io/constructorio-id');
+var fetchPonyfill = require('fetch-ponyfill');
 
-var fetchPonyfill = require('fetch-ponyfill'); // Modules
-
-
+// Modules
 var Search = require('./modules/search');
-
 var Browse = require('./modules/browse');
-
 var Autocomplete = require('./modules/autocomplete');
-
 var Recommendations = require('./modules/recommendations');
-
 var Tracker = require('./modules/tracker');
-
 var EventDispatcher = require('./utils/event-dispatcher');
-
 var helpers = require('./utils/helpers');
-
 var _require = require('../package.json'),
-    packageVersion = _require.version;
-
-var Quizzes = require('./modules/quizzes'); // Compute package version string
-
+  packageVersion = _require.version;
+var Quizzes = require('./modules/quizzes');
 
+// Compute package version string
 var computePackageVersion = function computePackageVersion() {
   var versionPrefix = 'ciojs-client-';
   var versionModifiers = [];
-
   if (!helpers.canUseDOM()) {
     versionModifiers.push('domless');
   }
-
   if (typeof process !== 'undefined' && typeof process.env !== 'undefined' && process.env.BUNDLED) {
     versionModifiers.push('bundled');
   }
-
   return "".concat(versionPrefix).concat(versionModifiers.join('-')).concat(versionModifiers.length ? '-' : '').concat(packageVersion);
 };
+
 /**
  * Class to instantiate the ConstructorIO client.
  */
-
-
 var ConstructorIO = /*#__PURE__*/function () {
   /**
    * @param {object} parameters - Parameters for client instantiation
@@ -84,48 +68,45 @@ var ConstructorIO = /*#__PURE__*/function () {
     var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
     (0, _classCallCheck2["default"])(this, ConstructorIO);
     var apiKey = options.apiKey,
-        versionFromOptions = options.version,
-        serviceUrl = options.serviceUrl,
-        quizzesServiceUrl = options.quizzesServiceUrl,
-        segments = options.segments,
-        testCells = options.testCells,
-        clientId = options.clientId,
-        sessionId = options.sessionId,
-        userId = options.userId,
-        fetch = options.fetch,
-        trackingSendDelay = options.trackingSendDelay,
-        sendReferrerWithTrackingEvents = options.sendReferrerWithTrackingEvents,
-        sendTrackingEvents = options.sendTrackingEvents,
-        eventDispatcher = options.eventDispatcher,
-        idOptions = options.idOptions,
-        beaconMode = options.beaconMode,
-        networkParameters = options.networkParameters;
-
+      versionFromOptions = options.version,
+      serviceUrl = options.serviceUrl,
+      quizzesServiceUrl = options.quizzesServiceUrl,
+      segments = options.segments,
+      testCells = options.testCells,
+      clientId = options.clientId,
+      sessionId = options.sessionId,
+      userId = options.userId,
+      fetch = options.fetch,
+      trackingSendDelay = options.trackingSendDelay,
+      sendReferrerWithTrackingEvents = options.sendReferrerWithTrackingEvents,
+      sendTrackingEvents = options.sendTrackingEvents,
+      eventDispatcher = options.eventDispatcher,
+      idOptions = options.idOptions,
+      beaconMode = options.beaconMode,
+      networkParameters = options.networkParameters;
     if (!apiKey || typeof apiKey !== 'string') {
       throw new Error('API key is a required parameter of type string');
     }
-
     var session_id;
     var client_id;
-    var versionFromGlobal = typeof global !== 'undefined' && global.CLIENT_VERSION; // Initialize ID session if DOM context is available
+    var versionFromGlobal = typeof global !== 'undefined' && global.CLIENT_VERSION;
 
+    // Initialize ID session if DOM context is available
     if (helpers.canUseDOM()) {
       var _ConstructorioID = new ConstructorioID(idOptions || {});
-
       session_id = _ConstructorioID.session_id;
       client_id = _ConstructorioID.client_id;
     } else {
       // Validate session ID is provided
       if (!sessionId || typeof sessionId !== 'number') {
         throw new Error('sessionId is a required user parameter of type number');
-      } // Validate client ID is provided
-
+      }
 
+      // Validate client ID is provided
       if (!clientId || typeof clientId !== 'string') {
         throw new Error('clientId is a required user parameter of type string');
       }
     }
-
     this.options = {
       apiKey: apiKey,
       version: versionFromOptions || versionFromGlobal || computePackageVersion(),
@@ -146,17 +127,20 @@ var ConstructorIO = /*#__PURE__*/function () {
       beaconMode: beaconMode === false ? false : true,
       // Defaults to 'true',
       networkParameters: networkParameters || {}
-    }; // Expose global modules
+    };
 
+    // Expose global modules
     this.search = new Search(this.options);
     this.browse = new Browse(this.options);
     this.autocomplete = new Autocomplete(this.options);
     this.recommendations = new Recommendations(this.options);
     this.tracker = new Tracker(this.options);
-    this.quizzes = new Quizzes(this.options); // Dispatch initialization event
+    this.quizzes = new Quizzes(this.options);
 
+    // Dispatch initialization event
     new EventDispatcher(options.eventDispatcher).queue('instantiated', this.options);
   }
+
   /**
    * Sets the client options
    *
@@ -165,29 +149,23 @@ var ConstructorIO = /*#__PURE__*/function () {
    * @param {object} [testCells] - User test cells
    * @param {string} [userId] - User ID
    */
-
-
   (0, _createClass2["default"])(ConstructorIO, [{
     key: "setClientOptions",
     value: function setClientOptions(options) {
       if (Object.keys(options).length) {
         var apiKey = options.apiKey,
-            segments = options.segments,
-            testCells = options.testCells,
-            userId = options.userId;
-
+          segments = options.segments,
+          testCells = options.testCells,
+          userId = options.userId;
         if (apiKey) {
           this.options.apiKey = apiKey;
         }
-
         if (segments) {
           this.options.segments = segments;
         }
-
         if (testCells) {
           this.options.testCells = testCells;
         }
-
         if (userId) {
           this.options.userId = userId;
         }
@@ -196,12 +174,10 @@ var ConstructorIO = /*#__PURE__*/function () {
   }]);
   return ConstructorIO;
 }(); // Exposed for testing
+ConstructorIO.Tracker = Tracker;
 
-
-ConstructorIO.Tracker = Tracker; // Expose on window object if available
-
+// Expose on window object if available
 if (helpers.canUseDOM()) {
   window.ConstructorioClient = ConstructorIO;
 }
-
 module.exports = ConstructorIO;

package/lib/modules/autocomplete.js

@@ -1,84 +1,81 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
-
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
-
 /* eslint-disable object-curly-newline, no-underscore-dangle */
 var EventDispatcher = require('../utils/event-dispatcher');
-
 var _require = require('../utils/helpers'),
-    throwHttpErrorFromResponse = _require.throwHttpErrorFromResponse,
-    cleanParams = _require.cleanParams,
-    applyNetworkTimeout = _require.applyNetworkTimeout,
-    trimNonBreakingSpaces = _require.trimNonBreakingSpaces,
-    encodeURIComponentRFC3986 = _require.encodeURIComponentRFC3986,
-    stringify = _require.stringify; // Create URL from supplied query (term) and parameters
-
-
+  throwHttpErrorFromResponse = _require.throwHttpErrorFromResponse,
+  cleanParams = _require.cleanParams,
+  applyNetworkTimeout = _require.applyNetworkTimeout,
+  trimNonBreakingSpaces = _require.trimNonBreakingSpaces,
+  encodeURIComponentRFC3986 = _require.encodeURIComponentRFC3986,
+  stringify = _require.stringify;
+
+// Create URL from supplied query (term) and parameters
 function createAutocompleteUrl(query, parameters, options) {
   var apiKey = options.apiKey,
-      version = options.version,
-      serviceUrl = options.serviceUrl,
-      sessionId = options.sessionId,
-      clientId = options.clientId,
-      userId = options.userId,
-      segments = options.segments,
-      testCells = options.testCells;
+    version = options.version,
+    serviceUrl = options.serviceUrl,
+    sessionId = options.sessionId,
+    clientId = options.clientId,
+    userId = options.userId,
+    segments = options.segments,
+    testCells = options.testCells;
   var queryParams = {
     c: version
   };
   queryParams.key = apiKey;
   queryParams.i = clientId;
-  queryParams.s = sessionId; // Validate query (term) is provided
+  queryParams.s = sessionId;
 
+  // Validate query (term) is provided
   if (!query || typeof query !== 'string') {
     throw new Error('query is a required parameter of type string');
-  } // Pull test cells from options
-
+  }
 
+  // Pull test cells from options
   if (testCells) {
     Object.keys(testCells).forEach(function (testCellKey) {
       queryParams["ef-".concat(testCellKey)] = testCells[testCellKey];
     });
-  } // Pull user segments from options
-
+  }
 
+  // Pull user segments from options
   if (segments && segments.length) {
     queryParams.us = segments;
-  } // Pull user id from options and ensure string
-
+  }
 
+  // Pull user id from options and ensure string
   if (userId) {
     queryParams.ui = String(userId);
   }
-
   if (parameters) {
     var numResults = parameters.numResults,
-        resultsPerSection = parameters.resultsPerSection,
-        filters = parameters.filters,
-        hiddenFields = parameters.hiddenFields,
-        variationsMap = parameters.variationsMap; // Pull results number from parameters
+      resultsPerSection = parameters.resultsPerSection,
+      filters = parameters.filters,
+      hiddenFields = parameters.hiddenFields,
+      variationsMap = parameters.variationsMap;
 
+    // Pull results number from parameters
     if (numResults) {
       queryParams.num_results = numResults;
-    } // Pull results number per section from parameters
-
+    }
 
+    // Pull results number per section from parameters
     if (resultsPerSection) {
       Object.keys(resultsPerSection).forEach(function (section) {
         queryParams["num_results_".concat(section)] = resultsPerSection[section];
       });
-    } // Pull filters from parameters
-
+    }
 
+    // Pull filters from parameters
     if (filters) {
       queryParams.filters = filters;
-    } // Pull hidden fields from parameters
-
+    }
 
+    // Pull hidden fields from parameters
     if (hiddenFields) {
       if (queryParams.fmt_options) {
         queryParams.fmt_options.hidden_fields = hiddenFields;
@@ -87,14 +84,13 @@ function createAutocompleteUrl(query, parameters, options) {
           hidden_fields: hiddenFields
         };
       }
-    } // Pull variations map from parameters
-
+    }
 
+    // Pull variations map from parameters
     if (variationsMap) {
       queryParams.variations_map = JSON.stringify(variationsMap);
     }
   }
-
   queryParams._dt = Date.now();
   queryParams = cleanParams(queryParams);
   var queryString = stringify(queryParams);
@@ -102,6 +98,7 @@ function createAutocompleteUrl(query, parameters, options) {
 
   return "".concat(serviceUrl, "/autocomplete/").concat(encodeURIComponentRFC3986(trimNonBreakingSpaces(cleanedQuery)), "?").concat(queryString);
 }
+
 /**
  * Interface to autocomplete related API calls.
  *
@@ -109,14 +106,13 @@ function createAutocompleteUrl(query, parameters, options) {
  * @inner
  * @returns {object}
  */
-
-
 var Autocomplete = /*#__PURE__*/function () {
   function Autocomplete(options) {
     (0, _classCallCheck2["default"])(this, Autocomplete);
     this.options = options || {};
     this.eventDispatcher = new EventDispatcher(options.eventDispatcher);
   }
+
   /**
    * Retrieve autocomplete results from API
    *
@@ -144,38 +140,32 @@ var Autocomplete = /*#__PURE__*/function () {
    *     },
    * });
    */
-
-
   (0, _createClass2["default"])(Autocomplete, [{
     key: "getAutocompleteResults",
     value: function getAutocompleteResults(query, parameters) {
       var _this = this;
-
       var networkParameters = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
       var requestUrl;
       var fetch = this.options.fetch;
       var signal;
-
       if (typeof AbortController === 'function') {
         var controller = new AbortController();
-        signal = controller && controller.signal; // Handle network timeout if specified
+        signal = controller && controller.signal;
 
+        // Handle network timeout if specified
         applyNetworkTimeout(this.options, networkParameters, controller);
       }
-
       try {
         requestUrl = createAutocompleteUrl(query, parameters, this.options);
       } catch (e) {
         return Promise.reject(e);
       }
-
       return fetch(requestUrl, {
         signal: signal
       }).then(function (response) {
         if (response.ok) {
           return response.json();
         }
-
         return throwHttpErrorFromResponse(new Error(), response);
       }).then(function (json) {
         if (json.sections) {
@@ -183,7 +173,6 @@ var Autocomplete = /*#__PURE__*/function () {
             var sectionKeys = Object.keys(json.sections);
             sectionKeys.forEach(function (section) {
               var sectionItems = json.sections[section];
-
               if (sectionItems.length) {
                 // Append `result_id` to each section item
                 sectionItems.forEach(function (item) {
@@ -193,17 +182,13 @@ var Autocomplete = /*#__PURE__*/function () {
               }
             });
           }
-
           _this.eventDispatcher.queue('autocomplete.getAutocompleteResults.completed', json);
-
           return json;
         }
-
         throw new Error('getAutocompleteResults response data is malformed');
       });
     }
   }]);
   return Autocomplete;
 }();
-
 module.exports = Autocomplete;