algoliasearch-helper 3.7.2 → 3.8.0

package/CHANGELOG

@@ -1,3 +1,14 @@
+3.8.0 - 2022-04-04
+ * ci(codesandbox): set up (#899) https://github.com/algolia/algoliasearch-helper-js/commit/ac7de4458f31c01da4e682cabee357e6300e147a
+ * ci(typescript): run type tests in CI (#898) https://github.com/algolia/algoliasearch-helper-js/commit/4d45118ef64a8c6352d2e75618df4e18a149ba64
+ * feat(facetValues): offer escaped value (#889) https://github.com/algolia/algoliasearch-helper-js/commit/4bae51bdefd217f3ef9ab9bf02fb653f3b8ae643
+
+3.7.4 - 2022-03-21
+ * fix(type): implement correctly https://github.com/algolia/algoliasearch-helper-js/commit/1c8670b21a507024d2ddf797feae5bb15343c244
+
+3.7.3 - 2022-03-18
+ * fix(ts): remove stray comment https://github.com/algolia/algoliasearch-helper-js/commit/24fe8de4bebc74500b33c95b124500b8499ef588
+
 3.7.2 - 2022-03-18
  * chore(docs): fix capitalization of Github and npm https://github.com/algolia/algoliasearch-helper-js/commit/5babbcad0b3d406a0b56f7a55682ff169e2b853f
  * fix(results): implement search result options via an argument https://github.com/algolia/algoliasearch-helper-js/commit/4e6ac6926bd284c7eafe060480fc4258844d121a

package/dist/algoliasearch.helper.js

@@ -71,7 +71,7 @@ algoliasearchHelper.SearchResults = SearchResults;
 
 module.exports = algoliasearchHelper;
 
-},{"./src/SearchParameters":5,"./src/SearchResults":7,"./src/algoliasearch.helper":8,"./src/version.js":23}],2:[function(require,module,exports){
+},{"./src/SearchParameters":5,"./src/SearchResults":7,"./src/algoliasearch.helper":8,"./src/version.js":24}],2:[function(require,module,exports){
 // Copyright Joyent, Inc. and other Node contributors.
 //
 // Permission is hereby granted, free of charge, to any person obtaining a
@@ -415,7 +415,7 @@ DerivedHelper.prototype.getModifiedState = function(parameters) {
 
 module.exports = DerivedHelper;
 
-},{"../functions/inherits":14,"@algolia/events":2}],4:[function(require,module,exports){
+},{"../functions/inherits":15,"@algolia/events":2}],4:[function(require,module,exports){
 'use strict';
 
 /**
@@ -564,7 +564,7 @@ var lib = {
 
 module.exports = lib;
 
-},{"../functions/defaultsPure":10,"../functions/objectHasKeys":17,"../functions/omit":18}],5:[function(require,module,exports){
+},{"../functions/defaultsPure":10,"../functions/objectHasKeys":18,"../functions/omit":19}],5:[function(require,module,exports){
 'use strict';
 
 var merge = require('../functions/merge');
@@ -2076,7 +2076,7 @@ SearchParameters.prototype = {
  */
 module.exports = SearchParameters;
 
-},{"../functions/defaultsPure":10,"../functions/find":11,"../functions/intersection":15,"../functions/merge":16,"../functions/objectHasKeys":17,"../functions/omit":18,"../functions/valToNumber":20,"../utils/isValidUserToken":22,"./RefinementList":4}],6:[function(require,module,exports){
+},{"../functions/defaultsPure":10,"../functions/find":12,"../functions/intersection":16,"../functions/merge":17,"../functions/objectHasKeys":18,"../functions/omit":19,"../functions/valToNumber":21,"../utils/isValidUserToken":23,"./RefinementList":4}],6:[function(require,module,exports){
 'use strict';
 
 module.exports = generateTrees;
@@ -2084,6 +2084,9 @@ module.exports = generateTrees;
 var orderBy = require('../functions/orderBy');
 var find = require('../functions/find');
 var prepareHierarchicalFacetSortBy = require('../functions/formatSort');
+var fv = require('../functions/escapeFacetValue');
+var escapeFacetValue = fv.escapeFacetValue;
+var unescapeFacetValue = fv.unescapeFacetValue;
 
 function generateTrees(state) {
   return function generate(hierarchicalFacetResult, hierarchicalFacetIndex) {
@@ -2130,6 +2133,7 @@ function generateTrees(state) {
       count: null, // root level, no count
       isRefined: true, // root level, always refined
       path: null, // root level, no path
+      escapedValue: null,
       exhaustive: rootExhaustive,
       data: null
     });
@@ -2205,7 +2209,7 @@ function generateHierarchicalTree(
             facetCount,
             facetValue,
             hierarchicalSeparator,
-            currentRefinement,
+            unescapeFacetValue(currentRefinement),
             hierarchicalFacetResult.exhaustive
           );
         }),
@@ -2268,6 +2272,7 @@ function format(
   return {
     name: parts[parts.length - 1].trim(),
     path: facetValue,
+    escapedValue: escapeFacetValue(facetValue),
     count: facetCount,
     isRefined:
       currentRefinement === facetValue ||
@@ -2277,7 +2282,7 @@ function format(
   };
 }
 
-},{"../functions/find":11,"../functions/formatSort":13,"../functions/orderBy":19}],7:[function(require,module,exports){
+},{"../functions/escapeFacetValue":11,"../functions/find":12,"../functions/formatSort":14,"../functions/orderBy":20}],7:[function(require,module,exports){
 'use strict';
 
 var merge = require('../functions/merge');
@@ -2287,6 +2292,9 @@ var compact = require('../functions/compact');
 var find = require('../functions/find');
 var findIndex = require('../functions/findIndex');
 var formatSort = require('../functions/formatSort');
+var fv = require('../functions/escapeFacetValue');
+var escapeFacetValue = fv.escapeFacetValue;
+var unescapeFacetValue = fv.unescapeFacetValue;
 
 var generateHierarchicalTree = require('./generate-hierarchical-tree');
 
@@ -2788,7 +2796,7 @@ function SearchResults(state, results, options) {
           state.disjunctiveFacetsRefinements[dfacet].forEach(function(refinementValue) {
             // add the disjunctive refinements if it is no more retrieved
             if (!self.disjunctiveFacets[position].data[refinementValue] &&
-              state.disjunctiveFacetsRefinements[dfacet].indexOf(refinementValue) > -1) {
+              state.disjunctiveFacetsRefinements[dfacet].indexOf(unescapeFacetValue(refinementValue)) > -1) {
               self.disjunctiveFacets[position].data[refinementValue] = 0;
             }
           });
@@ -2920,10 +2928,12 @@ function extractNormalizedFacetValues(results, attribute) {
     if (!facet) return [];
 
     return Object.keys(facet.data).map(function(name) {
+      var value = escapeFacetValue(name);
       return {
         name: name,
+        escapedValue: value,
         count: facet.data[name],
-        isRefined: results._state.isFacetRefined(attribute, name),
+        isRefined: results._state.isFacetRefined(attribute, value),
         isExcluded: results._state.isExcludeRefined(attribute, name)
       };
     });
@@ -2932,10 +2942,12 @@ function extractNormalizedFacetValues(results, attribute) {
     if (!disjunctiveFacet) return [];
 
     return Object.keys(disjunctiveFacet.data).map(function(name) {
+      var value = escapeFacetValue(name);
       return {
         name: name,
+        escapedValue: value,
         count: disjunctiveFacet.data[name],
-        isRefined: results._state.isDisjunctiveFacetRefined(attribute, name)
+        isRefined: results._state.isDisjunctiveFacetRefined(attribute, value)
       };
     });
   } else if (results._state.isHierarchicalFacet(attribute)) {
@@ -3300,7 +3312,7 @@ function getHierarchicalRefinement(state, attributeName, name, resultsFacets) {
 
 module.exports = SearchResults;
 
-},{"../functions/compact":9,"../functions/defaultsPure":10,"../functions/find":11,"../functions/findIndex":12,"../functions/formatSort":13,"../functions/merge":16,"../functions/orderBy":19,"./generate-hierarchical-tree":6}],8:[function(require,module,exports){
+},{"../functions/compact":9,"../functions/defaultsPure":10,"../functions/escapeFacetValue":11,"../functions/find":12,"../functions/findIndex":13,"../functions/formatSort":14,"../functions/merge":17,"../functions/orderBy":20,"./generate-hierarchical-tree":6}],8:[function(require,module,exports){
 'use strict';
 
 var SearchParameters = require('./SearchParameters');
@@ -3315,6 +3327,7 @@ var omit = require('./functions/omit');
 var merge = require('./functions/merge');
 
 var version = require('./version');
+var escapeFacetValue = require('./functions/escapeFacetValue').escapeFacetValue;
 
 /**
  * Event triggered when a parameter is set or updated
@@ -3664,9 +3677,10 @@ AlgoliaSearchHelper.prototype.searchForFacetValues = function(facet, query, maxF
     content = Array.isArray(content) ? content[0] : content;
 
     content.facetHits.forEach(function(f) {
+      f.escapedValue = escapeFacetValue(f.value);
       f.isRefined = isDisjunctive
-        ? state.isDisjunctiveFacetRefined(facet, f.value)
-        : state.isFacetRefined(facet, f.value);
+        ? state.isDisjunctiveFacetRefined(facet, f.escapedValue)
+        : state.isFacetRefined(facet, f.escapedValue);
     });
 
     return content;
@@ -4769,7 +4783,7 @@ AlgoliaSearchHelper.prototype.hasPendingRequests = function() {
 
 module.exports = AlgoliaSearchHelper;
 
-},{"./DerivedHelper":3,"./SearchParameters":5,"./SearchResults":7,"./functions/inherits":14,"./functions/merge":16,"./functions/objectHasKeys":17,"./functions/omit":18,"./requestBuilder":21,"./version":23,"@algolia/events":2}],9:[function(require,module,exports){
+},{"./DerivedHelper":3,"./SearchParameters":5,"./SearchResults":7,"./functions/escapeFacetValue":11,"./functions/inherits":15,"./functions/merge":17,"./functions/objectHasKeys":18,"./functions/omit":19,"./requestBuilder":22,"./version":24,"@algolia/events":2}],9:[function(require,module,exports){
 'use strict';
 
 module.exports = function compact(array) {
@@ -4806,6 +4820,34 @@ module.exports = function defaultsPure() {
 },{}],11:[function(require,module,exports){
 'use strict';
 
+/**
+ * Replaces a leading - with \-
+ * @private
+ * @param {string} value the facet value to replace
+ * @returns string
+ */
+function escapeFacetValue(value) {
+  return value.replace(/^-/, '\\-');
+}
+
+/**
+ * Replaces a leading \- with -
+ * @private
+ * @param {string} value the escaped facet value
+ * @returns string
+ */
+function unescapeFacetValue(value) {
+  return value.replace(/^\\-/, '-');
+}
+
+module.exports = {
+  escapeFacetValue: escapeFacetValue,
+  unescapeFacetValue: unescapeFacetValue
+};
+
+},{}],12:[function(require,module,exports){
+'use strict';
+
 // @MAJOR can be replaced by native Array#find when we change support
 module.exports = function find(array, comparator) {
   if (!Array.isArray(array)) {
@@ -4819,7 +4861,7 @@ module.exports = function find(array, comparator) {
   }
 };
 
-},{}],12:[function(require,module,exports){
+},{}],13:[function(require,module,exports){
 'use strict';
 
 // @MAJOR can be replaced by native Array#findIndex when we change support
@@ -4836,7 +4878,7 @@ module.exports = function find(array, comparator) {
   return -1;
 };
 
-},{}],13:[function(require,module,exports){
+},{}],14:[function(require,module,exports){
 'use strict';
 
 var find = require('./find');
@@ -4876,7 +4918,7 @@ module.exports = function formatSort(sortBy, defaults) {
   );
 };
 
-},{"./find":11}],14:[function(require,module,exports){
+},{"./find":12}],15:[function(require,module,exports){
 'use strict';
 
 function inherits(ctor, superCtor) {
@@ -4892,7 +4934,7 @@ function inherits(ctor, superCtor) {
 
 module.exports = inherits;
 
-},{}],15:[function(require,module,exports){
+},{}],16:[function(require,module,exports){
 'use strict';
 
 function intersection(arr1, arr2) {
@@ -4906,7 +4948,7 @@ function intersection(arr1, arr2) {
 
 module.exports = intersection;
 
-},{}],16:[function(require,module,exports){
+},{}],17:[function(require,module,exports){
 'use strict';
 
 function clone(value) {
@@ -4989,7 +5031,7 @@ function merge(target) {
 
 module.exports = merge;
 
-},{}],17:[function(require,module,exports){
+},{}],18:[function(require,module,exports){
 'use strict';
 
 function objectHasKeys(obj) {
@@ -4998,7 +5040,7 @@ function objectHasKeys(obj) {
 
 module.exports = objectHasKeys;
 
-},{}],18:[function(require,module,exports){
+},{}],19:[function(require,module,exports){
 'use strict';
 
 // https://github.com/babel/babel/blob/3aaafae053fa75febb3aa45d45b6f00646e30ba4/packages/babel-helpers/src/helpers.js#L604-L620
@@ -5018,7 +5060,7 @@ function _objectWithoutPropertiesLoose(source, excluded) {
 
 module.exports = _objectWithoutPropertiesLoose;
 
-},{}],19:[function(require,module,exports){
+},{}],20:[function(require,module,exports){
 'use strict';
 
 function compareAscending(value, other) {
@@ -5099,7 +5141,7 @@ function orderBy(collection, iteratees, orders) {
 
 module.exports = orderBy;
 
-},{}],20:[function(require,module,exports){
+},{}],21:[function(require,module,exports){
 'use strict';
 
 function valToNumber(v) {
@@ -5116,7 +5158,7 @@ function valToNumber(v) {
 
 module.exports = valToNumber;
 
-},{}],21:[function(require,module,exports){
+},{}],22:[function(require,module,exports){
 'use strict';
 
 var merge = require('./functions/merge');
@@ -5439,7 +5481,7 @@ var requestBuilder = {
 
 module.exports = requestBuilder;
 
-},{"./functions/merge":16}],22:[function(require,module,exports){
+},{"./functions/merge":17}],23:[function(require,module,exports){
 'use strict';
 
 module.exports = function isValidUserToken(userToken) {
@@ -5449,10 +5491,10 @@ module.exports = function isValidUserToken(userToken) {
   return /^[a-zA-Z0-9_-]{1,64}$/.test(userToken);
 };
 
-},{}],23:[function(require,module,exports){
+},{}],24:[function(require,module,exports){
 'use strict';
 
-module.exports = '3.7.2';
+module.exports = '3.8.0';
 
 },{}]},{},[1])(1)
 });