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

package/lib/types/types.d.ts

@@ -0,0 +1,126 @@
+import EventDispatcher from './event-dispatcher';
+
+export interface ConstructorClientOptions {
+	apiKey: string;
+	version?: string;
+	serviceUrl?: string;
+	// session id is of type string in jsdocs but of type number in code usage
+	sessionId?: string;
+	clientId?: string;
+	userId?: string;
+	segments?: string[];
+	testCells?: Record<string, string>;
+	fetch?: any;
+	trackingSendDelay?: number;
+	sendTrackingEvents?: boolean;
+	sendReferrerWithTrackingEvents?: boolean;
+	eventDispatcher?: EventDispatcher;
+	beaconMode?: boolean;
+	networkParameters?: {
+		timeout: number;
+	};
+}
+
+export interface RequestFeature extends Record<string, any> {
+	query_items: boolean;
+	auto_generated_refined_query_rules: boolean;
+	manual_searchandizing: boolean;
+	personalization: boolean;
+	filter_items: boolean;
+}
+
+export interface RequestFeatureVariant extends Record<string, any> {
+	query_items: string;
+	auto_generated_refined_query_rules: string;
+	manual_searchandizing: string | null;
+	personalization: string;
+	filter_items: string;
+}
+
+export type ErrorData = {
+	message: string;
+	[key: string]: any;
+};
+
+export interface ResultSources extends Record<string, any> {
+	token_match: { count: number; [key: string]: any };
+	embeddings_match: { count: number; [key: string]: any };
+}
+
+export interface SortOption extends Record<string, any> {
+	sort_by: string;
+	display_name: string;
+	sort_order: string;
+	status: string;
+}
+
+export interface Feature extends Record<string, any> {
+	feature_name: string;
+	display_name: string;
+	enabled: boolean;
+	variant: {
+		name: string;
+		display_name: string;
+		[key: string]: any;
+	};
+}
+
+export interface FmtOption extends Record<string, any> {
+	groups_start: string;
+	groups_max_depth: number;
+}
+
+type Facet = RangeFacet | OptionFacet;
+
+export interface BaseFacet extends Record<string, any> {
+	data: Record<string, any>;
+	status: Record<string, any>;
+	display_name: string;
+	name: string;
+	hidden: boolean;
+}
+
+export interface RangeFacet extends BaseFacet, Record<string, any> {
+	max: number;
+	min: number;
+	type: "range";
+}
+
+export interface OptionFacet extends BaseFacet, Record<string, any> {
+	options: FacetOption[];
+	type: "multiple" | "single" | "hierarchical";
+}
+
+export interface FacetOption extends Record<string, any> {
+	count: number;
+	display_name: string;
+	value: string;
+	options?: FacetOption[];
+	range?: ["-inf" | number, "inf" | number];
+	status: string;
+}
+
+export interface Group extends BaseGroup, Record<string, any> {
+	count: number;
+	data: Record<string, any>;
+	parents: BaseGroup[];
+	children: Group[];
+}
+
+export interface Collection extends Record<string, any> {
+	collection_id: string,
+	display_name: string,
+	data: Record<string, any>
+}
+
+export interface BaseGroup extends Record<string, any> {
+	display_name: string;
+	group_id: string;
+}
+
+export interface FmtOptions extends Record<string, any> {
+	
+}
+
+export type Nullable<T> = T | null;
+

package/lib/utils/helpers.js

@@ -10,6 +10,13 @@ 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();
@@ -197,6 +204,41 @@ var utils = {
       snakeCasedObj[newKey] = toRecurse && (0, _typeof2["default"])(camelCasedObj[key]) === 'object' && !Array.isArray(camelCasedObj[key]) ? utils.toSnakeCaseKeys(camelCasedObj[key], toRecurse) : camelCasedObj[key];
     });
     return snakeCasedObj;
+  },
+  containsPii: function containsPii(query) {
+    var piiRegex = Object.values(PII_REGEX);
+    var normalizedTerm = query.toLowerCase();
+    return piiRegex.some(function (regex) {
+      return regex.test(normalizedTerm);
+    });
+  },
+  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
+    }
+
+    return false;
   }
 };
 module.exports = utils;

package/lib/utils/request-queue.js

@@ -13,6 +13,9 @@ var HumanityCheck = require('./humanity-check');
 
 var helpers = require('./helpers');
 
+var _require = require('./helpers'),
+    requestContainsPii = _require.requestContainsPii;
+
 var storageKey = '_constructorio_requests';
 var requestTTL = 180000; // 3 minutes in milliseconds
 
@@ -47,6 +50,10 @@ var RequestQueue = /*#__PURE__*/function () {
       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,

package/package.json

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