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

package/lib/utils/helpers.js

@@ -1,22 +1,18 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
 var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
-
 /* eslint-disable no-param-reassign */
 var CRC32 = require('crc-32');
-
 var store = require('./store');
-
 var purchaseEventStorageKey = '_constructorio_purchase_order_ids';
 var PII_REGEX = {
   email: /^[\w\-+\\.]+@([\w-]+\.)+[\w-]{2,4}$/,
   phoneNumber: /^(?:\+\d{11,12}|\+\d{1,3}\s\d{3}\s\d{3}\s\d{3,4}|\(\d{3}\)\d{7}|\(\d{3}\)\s\d{3}\s\d{4}|\(\d{3}\)\d{3}-\d{4}|\(\d{3}\)\s\d{3}-\d{4})$/,
   creditCard: /^(?:4[0-9]{12}(?:[0-9]{3})?|(?:5[1-5][0-9]{2}|222[1-9]|22[3-9][0-9]|2[3-6][0-9]{2}|27[01][0-9]|2720)[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|6(?:011|5[0-9]{2})[0-9]{12}|(?:2131|1800|35\d{3})\d{11})$/ // Visa, Mastercard, Amex, Discover, JCB and Diners Club, regex source: https://www.regular-expressions.info/creditcard.html
   // Add more PII REGEX
-
 };
+
 var utils = {
   trimNonBreakingSpaces: function trimNonBreakingSpaces(string) {
     return string.replace(/\s/g, ' ').trim();
@@ -31,7 +27,6 @@ var utils = {
     var cleanedParams = {};
     Object.keys(paramsObj).forEach(function (paramKey) {
       var paramValue = paramsObj[paramKey];
-
       if (typeof paramValue === 'string') {
         // Replace non-breaking spaces (or any other type of spaces caught by the regex)
         // - with a regular white space
@@ -69,7 +64,6 @@ var utils = {
     if (utils.canUseDOM()) {
       return window.navigator;
     }
-
     return {
       userAgent: '',
       webdriver: false
@@ -82,7 +76,6 @@ var utils = {
     if (utils.canUseDOM()) {
       return window.location;
     }
-
     return {};
   },
   dispatchEvent: function dispatchEvent(event) {
@@ -102,48 +95,40 @@ var utils = {
         return evt;
       }
     }
-
     return null;
   },
   hasOrderIdRecord: function hasOrderIdRecord(orderId) {
     var orderIdHash = CRC32.str(orderId.toString());
     var purchaseEventStorage = store.local.get(purchaseEventStorageKey);
-
     if (typeof purchaseEventStorage === 'string') {
       purchaseEventStorage = JSON.parse(purchaseEventStorage);
     }
-
     if (purchaseEventStorage && purchaseEventStorage.includes(orderIdHash)) {
       return true;
     }
-
     return null;
   },
   addOrderIdRecord: function addOrderIdRecord(orderId) {
     var orderIdHash = CRC32.str(orderId.toString());
     var purchaseEventStorage = store.local.get(purchaseEventStorageKey);
-
     if (typeof purchaseEventStorage === 'string') {
       purchaseEventStorage = JSON.parse(purchaseEventStorage);
     }
-
     if (purchaseEventStorage) {
       // If the order already exists, do nothing
       if (purchaseEventStorage.includes(orderIdHash)) {
         return;
       }
-
       if (purchaseEventStorage.length >= 10) {
         purchaseEventStorage = purchaseEventStorage.slice(-9);
       }
-
       purchaseEventStorage.push(orderIdHash);
     } else {
       // Create a new object map for the order ids
       purchaseEventStorage = [orderIdHash];
-    } // Push the order id map into local storage
-
+    }
 
+    // Push the order id map into local storage
     store.local.set(purchaseEventStorageKey, purchaseEventStorage);
   },
   // Abort network request based on supplied timeout interval (in milliseconds)
@@ -155,7 +140,6 @@ var utils = {
     var optionsTimeout = options && options.networkParameters && options.networkParameters.timeout;
     var networkParametersTimeout = networkParameters && networkParameters.timeout;
     var timeout = networkParametersTimeout || optionsTimeout;
-
     if (typeof timeout === 'number' && controller) {
       setTimeout(function () {
         return controller.abort();
@@ -166,16 +150,15 @@ var utils = {
     if (!object) {
       return '';
     }
-
     var allValues = [];
     Object.keys(object).forEach(function (key) {
       var value = object[key];
       var encodedKey = utils.encodeURIComponentRFC3986(key);
-      var stringifiedValue; // Check for both null and undefined
+      var stringifiedValue;
 
+      // Check for both null and undefined
       if (value != null) {
         var nextPrefix = prefix ? "".concat(prefix, "%5B").concat(encodedKey, "%5D") : encodedKey;
-
         if (Array.isArray(value)) {
           stringifiedValue = utils.stringify(value, nextPrefix, 'array');
         } else if ((0, _typeof2["default"])(value) === 'object') {
@@ -185,7 +168,6 @@ var utils = {
         } else {
           stringifiedValue = "".concat(prefix || encodedKey, "=").concat(utils.encodeURIComponentRFC3986(value));
         }
-
         allValues.push(stringifiedValue);
       }
     });
@@ -215,29 +197,25 @@ var utils = {
   requestContainsPii: function requestContainsPii(urlString) {
     try {
       var _decodeURI, _decodeURIComponent;
-
       var url = new URL(urlString);
       var paths = (_decodeURI = decodeURI(url === null || url === void 0 ? void 0 : url.pathname)) === null || _decodeURI === void 0 ? void 0 : _decodeURI.split('/');
       var paramValues = (_decodeURIComponent = decodeURIComponent(url === null || url === void 0 ? void 0 : url.search)) === null || _decodeURIComponent === void 0 ? void 0 : _decodeURIComponent.split('&').map(function (param) {
         var _param$split;
-
         return param === null || param === void 0 ? void 0 : (_param$split = param.split('=')) === null || _param$split === void 0 ? void 0 : _param$split[1];
       });
-
       if (paths.some(function (path) {
         return utils.containsPii(path);
       })) {
         return true;
       }
-
       if (paramValues.some(function (value) {
         return utils.containsPii(value);
       })) {
         return true;
       }
-    } catch (e) {// do nothing
+    } catch (e) {
+      // do nothing
     }
-
     return false;
   }
 };

package/lib/utils/humanity-check.js

@@ -1,72 +1,63 @@
 "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 class-methods-use-this */
 var store = require('./store');
-
 var botList = require('./botlist');
-
 var helpers = require('./helpers');
-
 var storageKey = '_constructorio_is_human';
 var humanEvents = ['scroll', 'resize', 'touchmove', 'mouseover', 'mousemove', 'keydown', 'keypress', 'keyup', 'focus'];
-
 var HumanityCheck = /*#__PURE__*/function () {
   function HumanityCheck() {
     var _this = this;
-
     (0, _classCallCheck2["default"])(this, HumanityCheck);
-    this.isHumanBoolean = this.getIsHumanFromSessionStorage(); // Humanity proved, remove handlers to prove humanity
+    this.isHumanBoolean = this.getIsHumanFromSessionStorage();
 
+    // Humanity proved, remove handlers to prove humanity
     var remove = function remove() {
       _this.isHumanBoolean = true;
       store.session.set(storageKey, true);
       humanEvents.forEach(function (eventType) {
         helpers.removeEventListener(eventType, remove, true);
       });
-    }; // Add handlers to prove humanity
-
+    };
 
+    // Add handlers to prove humanity
     if (!this.isHumanBoolean) {
       humanEvents.forEach(function (eventType) {
         helpers.addEventListener(eventType, remove, true);
       });
     }
   }
-
   (0, _createClass2["default"])(HumanityCheck, [{
     key: "getIsHumanFromSessionStorage",
     value: function getIsHumanFromSessionStorage() {
       return !!store.session.get(storageKey) || false;
-    } // Return boolean indicating if is human
+    }
 
+    // Return boolean indicating if is human
   }, {
     key: "isHuman",
     value: function isHuman() {
       return this.isHumanBoolean || !!store.session.get(storageKey);
-    } // Return boolean indicating if useragent matches botlist
+    }
 
+    // Return boolean indicating if useragent matches botlist
   }, {
     key: "isBot",
     value: function isBot() {
       if (this.getIsHumanFromSessionStorage()) {
         return false;
       }
-
       var _helpers$getNavigator = helpers.getNavigator(),
-          userAgent = _helpers$getNavigator.userAgent,
-          webdriver = _helpers$getNavigator.webdriver;
-
+        userAgent = _helpers$getNavigator.userAgent,
+        webdriver = _helpers$getNavigator.webdriver;
       var botRegex = new RegExp("(".concat(botList.join('|'), ")"));
       return Boolean(userAgent.match(botRegex)) || Boolean(webdriver);
     }
   }]);
   return HumanityCheck;
 }();
-
 module.exports = HumanityCheck;

package/lib/utils/request-queue.js

@@ -1,28 +1,19 @@
 "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 brace-style, no-unneeded-ternary */
 var store = require('./store');
-
 var HumanityCheck = require('./humanity-check');
-
 var helpers = require('./helpers');
-
 var _require = require('./helpers'),
-    requestContainsPii = _require.requestContainsPii;
-
+  requestContainsPii = _require.requestContainsPii;
 var storageKey = '_constructorio_requests';
 var requestTTL = 180000; // 3 minutes in milliseconds
-
 var RequestQueue = /*#__PURE__*/function () {
   function RequestQueue(options, eventemitter) {
     var _this = this;
-
     (0, _classCallCheck2["default"])(this, RequestQueue);
     this.options = options;
     this.eventemitter = eventemitter;
@@ -30,30 +21,27 @@ var RequestQueue = /*#__PURE__*/function () {
     this.requestPending = false;
     this.pageUnloading = false;
     this.sendTrackingEvents = options && options.sendTrackingEvents === true ? true : false; // Defaults to 'false'
-    // Mark if page environment is unloading
 
+    // Mark if page environment is unloading
     helpers.addEventListener('beforeunload', function () {
       _this.pageUnloading = true;
     });
-
     if (this.sendTrackingEvents) {
       this.send();
     }
-  } // Add request to queue to be dispatched
-
+  }
 
+  // Add request to queue to be dispatched
   (0, _createClass2["default"])(RequestQueue, [{
     key: "queue",
     value: function queue(url) {
       var method = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 'GET';
       var body = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
       var networkParameters = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : {};
-
       if (this.sendTrackingEvents && !this.humanity.isBot()) {
         if (requestContainsPii(url, body)) {
           return;
         }
-
         var queue = RequestQueue.get();
         queue.push({
           url: url,
@@ -63,63 +51,59 @@ var RequestQueue = /*#__PURE__*/function () {
         });
         RequestQueue.set(queue);
       }
-    } // Read from queue and send events to server
+    }
 
+    // Read from queue and send events to server
   }, {
     key: "sendEvents",
     value: function sendEvents() {
       var _this2 = this;
-
       var fetch = this.options.fetch;
       var queue = RequestQueue.get();
-
-      if ( // Consider user "human" if no DOM context is available
+      if (
+      // Consider user "human" if no DOM context is available
       (!helpers.canUseDOM() || this.humanity.isHuman()) && !this.requestPending && !this.pageUnloading && queue.length) {
         var request;
         var nextInQueue = queue.shift();
         var _nextInQueue = nextInQueue,
-            networkParameters = _nextInQueue.networkParameters;
+          networkParameters = _nextInQueue.networkParameters;
         var signal;
         var instance = this;
         RequestQueue.set(queue);
-
         if (networkParameters && typeof AbortController === 'function') {
           var controller = new AbortController();
           signal = controller.signal;
           helpers.applyNetworkTimeout(this.options, networkParameters, controller);
-        } // Backwards compatibility with versions <= 2.0.0, can be removed in future
-        // - Request queue entries used to be strings with 'GET' method assumed
-
+        }
 
+        // Backwards compatibility with versions <= 2.0.0, can be removed in future
+        // - Request queue entries used to be strings with 'GET' method assumed
         if (typeof nextInQueue === 'string') {
           nextInQueue = {
             url: nextInQueue,
             method: 'GET'
           };
-        } // If events older than `requestTTL` exist in queue, clear request queue
+        }
+
+        // If events older than `requestTTL` exist in queue, clear request queue
         // - Prevents issue where stale items are sent in perpetuity
         // - No request should go unsent for longer than `requestTTL`
-
-
         if (nextInQueue.url) {
           // Pull `dt` parameter from URL, indicating origin time of request
           var dtMatch = nextInQueue.url.match(/\?.*_dt=([^&]+)/);
           var requestOriginTime = parseInt(dtMatch && dtMatch[1], 10);
           var now = +new Date();
-
           if (requestOriginTime && Number.isInteger(requestOriginTime) && now - requestOriginTime > requestTTL) {
             this.sendTrackingEvents = false;
             RequestQueue.remove();
             return;
           }
         }
-
         if (nextInQueue.method === 'GET') {
           request = fetch(nextInQueue.url, {
             signal: signal
           });
         }
-
         if (nextInQueue.method === 'POST') {
           request = fetch(nextInQueue.url, {
             method: nextInQueue.method,
@@ -131,7 +115,6 @@ var RequestQueue = /*#__PURE__*/function () {
             signal: signal
           });
         }
-
         if (request) {
           this.requestPending = true;
           request.then(function (response) {
@@ -144,11 +127,11 @@ var RequestQueue = /*#__PURE__*/function () {
                   message: 'ok'
                 });
               }
-
               _this2.requestPending = false;
-
               _this2.send();
-            } // Request was successful, but returned a non-2XX status code
+            }
+
+            // Request was successful, but returned a non-2XX status code
             else {
               response.json().then(function (json) {
                 if (instance.eventemitter) {
@@ -158,9 +141,7 @@ var RequestQueue = /*#__PURE__*/function () {
                     message: json && json.message
                   });
                 }
-
                 _this2.requestPending = false;
-
                 _this2.send();
               })["catch"](function (error) {
                 if (instance.eventemitter) {
@@ -170,9 +151,7 @@ var RequestQueue = /*#__PURE__*/function () {
                     message: error.type
                   });
                 }
-
                 _this2.requestPending = false;
-
                 _this2.send();
               });
             }
@@ -184,15 +163,14 @@ var RequestQueue = /*#__PURE__*/function () {
                 message: error && error.toString && error.toString()
               });
             }
-
             _this2.requestPending = false;
-
             _this2.send();
           });
         }
       }
-    } // Read from queue and send requests to server
+    }
 
+    // Read from queue and send requests to server
   }, {
     key: "send",
     value: function send() {
@@ -204,14 +182,16 @@ var RequestQueue = /*#__PURE__*/function () {
           setTimeout(this.sendEvents.bind(this), this.options && this.options.trackingSendDelay || 250);
         }
       }
-    } // Return current request queue
+    }
 
+    // Return current request queue
   }], [{
     key: "get",
     value: function get() {
       return store.local.get(storageKey) || [];
-    } // Update current request queue
+    }
 
+    // Update current request queue
   }, {
     key: "set",
     value: function set(queue) {
@@ -221,17 +201,18 @@ var RequestQueue = /*#__PURE__*/function () {
       } else {
         store.local.set(storageKey, queue);
       }
+      var localStorageQueue = RequestQueue.get();
 
-      var localStorageQueue = RequestQueue.get(); // Ensure storage queue was set correctly in storage by checking length
+      // Ensure storage queue was set correctly in storage by checking length
       // - Otherwise remove all pending requests as preventative measure
       // - Firefox seeing identical events being transmitted multiple times
-
       if (Array.isArray(localStorageQueue) && localStorageQueue.length !== queue.length) {
         this.sendTrackingEvents = false;
         RequestQueue.remove();
       }
-    } // Remove current request queue key
+    }
 
+    // Remove current request queue key
   }, {
     key: "remove",
     value: function remove() {
@@ -240,5 +221,4 @@ var RequestQueue = /*#__PURE__*/function () {
   }]);
   return RequestQueue;
 }();
-
 module.exports = RequestQueue;

package/lib/utils/store.js

@@ -1,10 +1,9 @@
 "use strict";
 
 var store = require('store2');
+var overflow = require('./store.overflow');
 
-var overflow = require('./store.overflow'); // Inject overflow into store
+// Inject overflow into store
 // https://raw.githubusercontent.com/nbubna/store/master/src/store.overflow.js
-
-
 overflow(store, store._);
 module.exports = store;

package/lib/utils/store.overflow.js

@@ -1,7 +1,6 @@
 "use strict";
 
 /* eslint-disable */
-
 /**
  * Copyright (c) 2013 ESHA Research
  * Dual licensed under the MIT and GPL licenses:
@@ -19,29 +18,24 @@
  */
 module.exports = function (store, _) {
   var _set = _.set,
-      _get = _.get,
-      _remove = _.remove,
-      _key = _.key,
-      _length = _.length,
-      _clear = _.clear;
-
+    _get = _.get,
+    _remove = _.remove,
+    _key = _.key,
+    _length = _.length,
+    _clear = _.clear;
   _.overflow = function (area, create) {
     var name = area === _.areas.local ? '+local+' : area === _.areas.session ? '+session+' : false;
-
     if (name) {
       var overflow = _.areas[name];
-
       if (create && !overflow) {
         overflow = store.area(name)._area; // area() copies to _.areas
       } else if (create === false) {
         delete _.areas[name];
         delete store[name];
       }
-
       return overflow;
     }
   };
-
   _.set = function (area, key, string) {
     try {
       _set.apply(this, arguments);
@@ -50,36 +44,26 @@ module.exports = function (store, _) {
         // the e.toString is needed for IE9 / IE10, cos name is empty there
         return _.set(_.overflow(area, true), key, string);
       }
-
       throw e;
     }
   };
-
   _.get = function (area, key) {
     var overflow = _.overflow(area);
-
     return overflow && _get.call(this, overflow, key) || _get.apply(this, arguments);
   };
-
   _.remove = function (area, key) {
     var overflow = _.overflow(area);
-
     if (overflow) {
       _remove.call(this, overflow, key);
     }
-
     _remove.apply(this, arguments);
   };
-
   _.key = function (area, i) {
     var overflow = _.overflow(area);
-
     if (overflow) {
       var l = _length.call(this, area);
-
       if (i >= l) {
         i = i - l; // make i overflow-relative
-
         for (var j = 0, m = _length.call(this, overflow); j < m; j++) {
           if (j === i) {
             // j is overflow index
@@ -88,20 +72,15 @@ module.exports = function (store, _) {
         }
       }
     }
-
     return _key.apply(this, arguments);
   };
-
   _.length = function (area) {
     var length = _length(area),
-        overflow = _.overflow(area);
-
+      overflow = _.overflow(area);
     return overflow ? length + _length(overflow) : length;
   };
-
   _.clear = function (area) {
     _.overflow(area, false);
-
     _clear.apply(this, arguments);
   };
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@constructor-io/constructorio-client-javascript",
-  "version": "2.37.0",
+  "version": "2.37.1",
   "description": "Constructor.io JavaScript client",
   "main": "lib/constructorio.js",
   "types": "lib/types/index.d.ts",