@constructor-io/constructorio-client-javascript 2.41.1 → 2.42.0

package/lib/constructorio.js

@@ -144,10 +144,11 @@ var ConstructorIO = /*#__PURE__*/function () {
   /**
    * Sets the client options
    *
-   * @param {string} apiKey - Constructor.io API key
-   * @param {array} [segments] - User segments
-   * @param {object} [testCells] - User test cells
-   * @param {string} [userId] - User ID
+   * @param {object} options - Client options to update
+   * @param {string} [options.apiKey] - Constructor.io API key
+   * @param {array} [options.segments] - User segments
+   * @param {object} [options.testCells] - User test cells
+   * @param {string} [options.userId] - User ID
    */
   (0, _createClass2["default"])(ConstructorIO, [{
     key: "setClientOptions",

package/lib/utils/helpers.js

@@ -6,12 +6,19 @@ var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
 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]{15}|(?: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 PII_REGEX = [{
+  pattern: /^[\w\-+\\.]+@([\w-]+\.)+[\w-]{2,4}$/,
+  replaceBy: '<email_omitted>'
+}, {
+  pattern: /^(?:\+\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})$/,
+  replaceBy: '<phone_omitted>'
+}, {
+  pattern: /^(?:4[0-9]{15}|(?: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
+  replaceBy: '<credit_omitted>'
+}
+// Add more PII REGEX
+];
 
 var utils = {
   trimNonBreakingSpaces: function trimNonBreakingSpaces(string) {
@@ -187,14 +194,12 @@ var utils = {
     });
     return snakeCasedObj;
   },
-  containsPii: function containsPii(query) {
-    var piiRegex = Object.values(PII_REGEX);
+  containsPii: function containsPii(query, piiPattern) {
     var normalizedTerm = query.toLowerCase();
-    return piiRegex.some(function (regex) {
-      return regex.test(normalizedTerm);
-    });
+    return piiPattern.test(normalizedTerm);
   },
-  requestContainsPii: function requestContainsPii(urlString) {
+  obfuscatePiiRequest: function obfuscatePiiRequest(urlString) {
+    var obfuscatedUrl = urlString;
     try {
       var _decodeURI, _decodeURIComponent;
       var url = new URL(urlString);
@@ -203,20 +208,18 @@ var utils = {
         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;
-      }
+      PII_REGEX.forEach(function (regex) {
+        paths.forEach(function (path) {
+          if (utils.containsPii(path, regex.pattern)) obfuscatedUrl = obfuscatedUrl.replaceAll(path, regex.replaceBy);
+        });
+        paramValues.forEach(function (param) {
+          if (utils.containsPii(param, regex.pattern)) obfuscatedUrl = obfuscatedUrl.replaceAll(param, regex.replaceBy);
+        });
+      });
     } catch (e) {
       // do nothing
     }
-    return false;
+    return obfuscatedUrl;
   }
 };
 module.exports = utils;

package/lib/utils/request-queue.js

@@ -8,7 +8,7 @@ var store = require('./store');
 var HumanityCheck = require('./humanity-check');
 var helpers = require('./helpers');
 var _require = require('./helpers'),
-  requestContainsPii = _require.requestContainsPii;
+  obfuscatePiiRequest = _require.obfuscatePiiRequest;
 var storageKey = '_constructorio_requests';
 var requestTTL = 180000; // 3 minutes in milliseconds
 var RequestQueue = /*#__PURE__*/function () {
@@ -39,12 +39,12 @@ var RequestQueue = /*#__PURE__*/function () {
       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();
+
+        // PII Detection & Obfuscation
+        var obfuscatedUrl = obfuscatePiiRequest(url);
         queue.push({
-          url: url,
+          url: obfuscatedUrl,
           method: method,
           body: body,
           networkParameters: networkParameters

package/package.json

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