@constructor-io/constructorio-client-javascript 2.39.1 → 2.41.0

package/lib/modules/autocomplete.js

@@ -55,6 +55,7 @@ function createAutocompleteUrl(query, parameters, options) {
     var numResults = parameters.numResults,
       resultsPerSection = parameters.resultsPerSection,
       filters = parameters.filters,
+      filtersPerSection = parameters.filtersPerSection,
       hiddenFields = parameters.hiddenFields,
       variationsMap = parameters.variationsMap;
 
@@ -75,6 +76,13 @@ function createAutocompleteUrl(query, parameters, options) {
       queryParams.filters = filters;
     }
 
+    // Pull filtersPerSection from parameters
+    if (filtersPerSection) {
+      Object.keys(filtersPerSection).forEach(function (section) {
+        queryParams["filters[".concat(section, "]")] = filtersPerSection[section];
+      });
+    }
+
     // Pull hidden fields from parameters
     if (hiddenFields) {
       if (queryParams.fmt_options) {
@@ -122,6 +130,7 @@ var Autocomplete = /*#__PURE__*/function () {
    * @param {object} [parameters] - Additional parameters to refine result set
    * @param {number} [parameters.numResults] - The total number of results to return
    * @param {object} [parameters.filters] - Key / value mapping (dictionary) of filters used to refine results
+   * @param {object} [parameters.filtersPerSection] - Filters used to refine results per section
    * @param {object} [parameters.resultsPerSection] - Number of results to return (value) per section (key)
    * @param {string[]} [parameters.hiddenFields] - Hidden metadata fields to return
    * @param {object} [parameters.variationsMap] - The variations map object to aggregate variations. Please refer to https://docs.constructor.io/rest_api/variations_mapping for details

package/lib/types/autocomplete.d.ts

@@ -13,6 +13,7 @@ export default Autocomplete;
 export interface IAutocompleteParameters {
   numResults?: number;
   filters?: Record<string, any>;
+  filtersPerSection?: Record<string, Record<string, any>>;
   resultsPerSection?: Record<string, number>;
   hiddenFields?: string[];
   variationsMap?: VariationsMap;

package/lib/utils/store.js

@@ -1,9 +1,143 @@
 "use strict";
 
-var store = require('store2');
-var overflow = require('./store.overflow');
-
-// Inject overflow into store
-// https://raw.githubusercontent.com/nbubna/store/master/src/store.overflow.js
-overflow(store, store._);
+var session = {
+  overflow: {},
+  get: function get(key) {
+    // Overflow
+    var valueFromOverflow = this.overflow[key];
+    if (valueFromOverflow) {
+      return valueFromOverflow;
+    }
+    if (typeof sessionStorage === 'undefined') {
+      return null;
+    }
+    var valueFromSession = sessionStorage.getItem(key);
+    if (valueFromSession) {
+      try {
+        // Try to parse the value and return
+        return JSON.parse(valueFromSession);
+      } catch (error) {
+        // If value exists but it's not valid JSON, still return the original value
+        return valueFromSession;
+      }
+    }
+    return null;
+  },
+  set: function set(key, value) {
+    try {
+      sessionStorage.setItem(key, JSON.stringify(value));
+    } catch (e) {
+      this.overflow[key] = value;
+    }
+  },
+  remove: function remove(key) {
+    var _this$overflow;
+    if ((_this$overflow = this.overflow) !== null && _this$overflow !== void 0 && _this$overflow[key]) {
+      delete this.overflow[key];
+    }
+    if (typeof sessionStorage !== 'undefined') {
+      sessionStorage.removeItem(key);
+    }
+  },
+  key: function key(i) {
+    var _sessionStorage, _sessionStorage2;
+    if (typeof sessionStorage === 'undefined') {
+      var _Object$keys;
+      return (_Object$keys = Object.keys(this.overflow)) === null || _Object$keys === void 0 ? void 0 : _Object$keys[i];
+    }
+    var keyFromSessionStorage = (_sessionStorage = sessionStorage) === null || _sessionStorage === void 0 ? void 0 : _sessionStorage.key(i);
+    var sessionStorageLength = ((_sessionStorage2 = sessionStorage) === null || _sessionStorage2 === void 0 ? void 0 : _sessionStorage2.length) || 0;
+    if (i >= sessionStorageLength) {
+      var _Object$keys2;
+      var overflowIndex = i - sessionStorageLength;
+      return (_Object$keys2 = Object.keys(this.overflow)) === null || _Object$keys2 === void 0 ? void 0 : _Object$keys2[overflowIndex];
+    }
+    return keyFromSessionStorage;
+  },
+  length: function length() {
+    var overflowLength = Object.keys(this.overflow).length;
+    if (typeof sessionStorage === 'undefined') {
+      return overflowLength;
+    }
+    return sessionStorage.length + overflowLength;
+  },
+  clear: function clear() {
+    this.overflow = {};
+    if (typeof sessionStorage !== 'undefined') {
+      sessionStorage.clear();
+    }
+  }
+};
+var local = {
+  overflow: {},
+  get: function get(key) {
+    // Overflow
+    var valueFromOverflow = this.overflow[key];
+    if (valueFromOverflow) {
+      return valueFromOverflow;
+    }
+    if (typeof localStorage === 'undefined') {
+      return null;
+    }
+    var valueFromLocal = localStorage.getItem(key);
+    if (valueFromLocal) {
+      try {
+        // Try to parse the value and return
+        return JSON.parse(valueFromLocal);
+      } catch (error) {
+        // If value exists but it's not valid JSON, still return the original value
+        return valueFromLocal;
+      }
+    }
+    return null;
+  },
+  set: function set(key, value) {
+    try {
+      localStorage.setItem(key, JSON.stringify(value));
+    } catch (e) {
+      this.overflow[key] = value;
+    }
+  },
+  remove: function remove(key) {
+    var _this$overflow2;
+    if ((_this$overflow2 = this.overflow) !== null && _this$overflow2 !== void 0 && _this$overflow2[key]) {
+      delete this.overflow[key];
+    }
+    if (typeof localStorage !== 'undefined') {
+      localStorage.removeItem(key);
+    }
+  },
+  key: function key(i) {
+    var _localStorage, _localStorage2;
+    if (typeof localStorage === 'undefined') {
+      var _Object$keys3;
+      return (_Object$keys3 = Object.keys(this.overflow)) === null || _Object$keys3 === void 0 ? void 0 : _Object$keys3[i];
+    }
+    var keyFromLocalStorage = (_localStorage = localStorage) === null || _localStorage === void 0 ? void 0 : _localStorage.key(i);
+    var localStorageLength = ((_localStorage2 = localStorage) === null || _localStorage2 === void 0 ? void 0 : _localStorage2.length) || 0;
+    if (i >= localStorageLength) {
+      var _Object$keys4;
+      var overflowIndex = i - localStorageLength;
+      return (_Object$keys4 = Object.keys(this.overflow)) === null || _Object$keys4 === void 0 ? void 0 : _Object$keys4[overflowIndex];
+    }
+    return keyFromLocalStorage;
+  },
+  length: function length() {
+    var overflowLength = Object.keys(this.overflow).length;
+    if (typeof localStorage === 'undefined') {
+      return overflowLength;
+    }
+    return localStorage.length + overflowLength;
+  },
+  clear: function clear() {
+    this.overflow = {};
+    if (typeof localStorage !== 'undefined') {
+      localStorage.clear();
+    }
+  }
+};
+var store = {
+  local: local,
+  session: session
+};
 module.exports = store;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@constructor-io/constructorio-client-javascript",
-  "version": "2.39.1",
+  "version": "2.41.0",
   "description": "Constructor.io JavaScript client",
   "main": "lib/constructorio.js",
   "types": "lib/types/index.d.ts",
@@ -23,7 +23,7 @@
     "coverage": "nyc --all --reporter=html npm run test:src",
     "postcoverage": "open coverage/index.html && rm -rf test",
     "docs": "jsdoc --configure ./.jsdoc.json ./README.md --recurse ./src --destination ./docs",
-    "compile": "babel src/ -d lib/ --copy-files && rm -rf lib/types/tests",
+    "compile": "rm -rf ./lib/* && babel src/ -d lib/ --copy-files && rm -rf ./lib/types/tests",
     "prepublish": "npm run compile",
     "bundle": "rm -rf ./dist/* && npm run compile && node bundle.js",
     "prepare": "husky install"
@@ -73,8 +73,7 @@
   "dependencies": {
     "@constructor-io/constructorio-id": "^2.4.17",
     "crc-32": "^1.2.2",
-    "fetch-ponyfill": "^7.1.0",
-    "store2": "^2.14.2"
+    "fetch-ponyfill": "^7.1.0"
   },
   "peerDependencies": {
     "@babel/runtime": "^7.19.0"

package/lib/types/types.d.ts

@@ -1,126 +0,0 @@
-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/store.overflow.js

@@ -1,86 +0,0 @@
-"use strict";
-
-/* eslint-disable */
-/**
- * Copyright (c) 2013 ESHA Research
- * Dual licensed under the MIT and GPL licenses:
- *   http://www.opensource.org/licenses/mit-license.php
- *   http://www.gnu.org/licenses/gpl.html
- *
- * When quota is reached on a storage area, this shifts incoming values to 
- * fake storage, so they last only as long as the page does. This is useful
- * because it is more burdensome for localStorage to recover from quota errors
- * than incomplete caches. In other words, it is wiser to rely on store.js
- * never complaining than never missing data. You should already be checking
- * the integrity of cached data on every page load.
- *
- * Status: BETA
- */
-module.exports = function (store, _) {
-  var _set = _.set,
-    _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);
-    } catch (e) {
-      if (e.name === 'QUOTA_EXCEEDED_ERR' || e.name === 'NS_ERROR_DOM_QUOTA_REACHED' || e.toString().indexOf("QUOTA_EXCEEDED_ERR") !== -1 || e.toString().indexOf("QuotaExceededError") !== -1) {
-        // 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
-            return _key.call(this, overflow, j);
-          }
-        }
-      }
-    }
-    return _key.apply(this, arguments);
-  };
-  _.length = function (area) {
-    var length = _length(area),
-      overflow = _.overflow(area);
-    return overflow ? length + _length(overflow) : length;
-  };
-  _.clear = function (area) {
-    _.overflow(area, false);
-    _clear.apply(this, arguments);
-  };
-};

package/lib/utils/store_old.js

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