@constructor-io/constructorio-client-javascript 2.26.4 → 2.27.1

package/lib/constructorio.js

@@ -25,7 +25,23 @@ var EventDispatcher = require('./utils/event-dispatcher');
 var helpers = require('./utils/helpers');
 
 var _require = require('../package.json'),
-    packageVersion = _require.version;
+    packageVersion = _require.version; // Compute package version string
+
+
+var computePackageVersion = function computePackageVersion() {
+  var versionPrefix = 'ciojs-client-';
+  var versionModifiers = [];
+
+  if (!helpers.canUseDOM()) {
+    versionModifiers.push('domless');
+  }
+
+  if (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.
  */
@@ -61,9 +77,8 @@ var ConstructorIO = /*#__PURE__*/function () {
   function ConstructorIO() {
     var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
     (0, _classCallCheck2["default"])(this, ConstructorIO);
-    var canUseDOM = helpers.canUseDOM();
     var apiKey = options.apiKey,
-        version = options.version,
+        versionFromOptions = options.version,
         serviceUrl = options.serviceUrl,
         segments = options.segments,
         testCells = options.testCells,
@@ -84,9 +99,10 @@ var ConstructorIO = /*#__PURE__*/function () {
     }
 
     var session_id;
-    var client_id; // Initialize ID session if DOM context is available
+    var client_id;
+    var versionFromGlobal = typeof global !== 'undefined' && global.CLIENT_VERSION; // Initialize ID session if DOM context is available
 
-    if (canUseDOM) {
+    if (helpers.canUseDOM()) {
       var _ConstructorioID = new ConstructorioID(idOptions || {});
 
       session_id = _ConstructorioID.session_id;
@@ -105,7 +121,7 @@ var ConstructorIO = /*#__PURE__*/function () {
 
     this.options = {
       apiKey: apiKey,
-      version: version || typeof global !== 'undefined' && global.CLIENT_VERSION || "ciojs-client-".concat(canUseDOM ? '' : 'domless-').concat(process.env.BUNDLED ? 'bundled-' : '').concat(packageVersion),
+      version: versionFromOptions || versionFromGlobal || computePackageVersion(),
       serviceUrl: serviceUrl && serviceUrl.replace(/\/$/, '') || 'https://ac.cnstrc.com',
       sessionId: sessionId || session_id,
       clientId: clientId || client_id,

package/lib/modules/tracker.js

@@ -304,7 +304,7 @@ var Tracker = /*#__PURE__*/function () {
      * @function trackSearchResultsLoaded
      * @param {string} term - Search results query term
      * @param {object} parameters - Additional parameters to be sent with request
-     * @param {number} parameters.num_results - Number of search results in total
+     * @param {number} parameters.num_results - Total number of results
      * @param {string[]} [parameters.item_ids] - List of product item unique identifiers in search results listing
      * @param {object} [networkParameters] - Parameters relevant to the network request
      * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
@@ -640,7 +640,7 @@ var Tracker = /*#__PURE__*/function () {
      * @param {string} parameters.url - Current page URL
      * @param {string} parameters.pod_id - Pod identifier
      * @param {number} parameters.num_results_viewed - Number of results viewed
-     * @param {number} [parameters.result_count] - Number of results displayed
+     * @param {number} [parameters.result_count] - Total number of results
      * @param {number} [parameters.result_page] - Page number of results
      * @param {string} [parameters.result_id] - Recommendation result identifier (returned in response from Constructor)
      * @param {string} [parameters.section="Products"] - Results section
@@ -732,7 +732,7 @@ var Tracker = /*#__PURE__*/function () {
      * @param {string} [parameters.variation_id] - Product item variation unique identifier
      * @param {string} [parameters.section="Products"] - Index section
      * @param {string} [parameters.result_id] - Recommendation result identifier (returned in response from Constructor)
-     * @param {number} [parameters.result_count] - Number of results displayed
+     * @param {number} [parameters.result_count] - Total number of results
      * @param {number} [parameters.result_page] - Page number of results
      * @param {number} [parameters.result_position_on_page] - Position of result on page
      * @param {number} [parameters.num_results_per_page] - Number of results on page
@@ -840,7 +840,7 @@ var Tracker = /*#__PURE__*/function () {
      * @param {string} parameters.filter_name - Filter name
      * @param {string} parameters.filter_value - Filter value
      * @param {string} [parameters.section="Products"] - Index section
-     * @param {number} [parameters.result_count] - Number of results displayed
+     * @param {number} [parameters.result_count] - Total number of results
      * @param {number} [parameters.result_page] - Page number of results
      * @param {string} [parameters.result_id] - Browse result identifier (returned in response from Constructor)
      * @param {string} [parameters.selected_filters] - Selected filters
@@ -959,7 +959,7 @@ var Tracker = /*#__PURE__*/function () {
      * @param {string} [parameters.section="Products"] - Index section
      * @param {string} [parameters.variation_id] - Product item variation unique identifier
      * @param {string} [parameters.result_id] - Browse result identifier (returned in response from Constructor)
-     * @param {number} [parameters.result_count] - Number of results displayed
+     * @param {number} [parameters.result_count] - Total number of results
      * @param {number} [parameters.result_page] - Page number of results
      * @param {number} [parameters.result_position_on_page] - Position of clicked item
      * @param {number} [parameters.num_results_per_page] - Number of results shown

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@constructor-io/constructorio-client-javascript",
-  "version": "2.26.4",
+  "version": "2.27.1",
   "description": "Constructor.io JavaScript client",
   "main": "lib/constructorio.js",
   "scripts": {
@@ -18,7 +18,8 @@
     "docs": "jsdoc --configure ./.jsdoc.json ./README.md --recurse ./src --destination ./docs",
     "compile": "babel src/ -d lib/",
     "prepublish": "npm run compile",
-    "bundle": "rm -rf ./dist/* && npm run compile && node bundle.js"
+    "bundle": "rm -rf ./dist/* && npm run compile && node bundle.js",
+    "prepare": "husky install"
   },
   "repository": {
     "type": "git",
@@ -30,9 +31,6 @@
     "url": "https://github.com/Constructor-io/constructorio-client-javascript/issues"
   },
   "homepage": "https://github.com/Constructor-io/constructorio-client-javascript#readme",
-  "pre-push": [
-    "lint"
-  ],
   "files": [
     "lib/**/*"
   ],
@@ -49,6 +47,7 @@
     "eslint": "^8.0.1",
     "eslint-config-airbnb-base": "^13.1.0",
     "eslint-plugin-import": "^2.25.2",
+    "husky": "^7.0.4",
     "jsdoc": "^3.6.7",
     "jsdom": "^15.1.1",
     "license-checker": "^25.0.1",
@@ -57,13 +56,12 @@
     "mocha": "^9.1.3",
     "mocha-jsdom": "^2.0.0",
     "nyc": "^15.1.0",
-    "pre-push": "^0.1.1",
     "serve": "^13.0.2",
     "sinon": "^7.5.0",
     "sinon-chai": "^3.7.0"
   },
   "dependencies": {
-    "@constructor-io/constructorio-id": "^2.4.6",
+    "@constructor-io/constructorio-id": "^2.4.8",
     "crc-32": "^1.2.0",
     "es6-promise": "^4.2.8",
     "events": "^3.0.0",