instantsearch.js 4.37.2 → 4.37.3

package/CHANGELOG.md

@@ -1,3 +1,12 @@
+## [4.37.3](https://github.com/algolia/instantsearch.js/compare/v4.37.2...v4.37.3) (2022-01-25)
+
+
+### Bug Fixes
+
+* **helpers:** display warning if attribute cannot be highlighted/snippeted ([#4996](https://github.com/algolia/instantsearch.js/issues/4996)) ([e81bf59](https://github.com/algolia/instantsearch.js/commit/e81bf59f0f28eb7b9f54f7d4424c60546b9a4d8c))
+
+
+
 ## [4.37.2](https://github.com/algolia/instantsearch.js/compare/v4.37.1...v4.37.2) (2022-01-10)
 
 

package/cjs/connectors/breadcrumb/connectBreadcrumb.js

@@ -94,6 +94,9 @@ var connectBreadcrumb = function connectBreadcrumb(renderFn) {
             state = _ref2.state;
 
         function getItems() {
+          // The hierarchicalFacets condition is required for flavors
+          // that render immediately with empty results, without relying
+          // on init() (like React InstantSearch Hooks).
           if (!results || state.hierarchicalFacets.length === 0) {
             return [];
           }

package/cjs/helpers/highlight.js

@@ -18,8 +18,11 @@ function highlight(_ref) {
       hit = _ref.hit,
       _ref$cssClasses = _ref.cssClasses,
       cssClasses = _ref$cssClasses === void 0 ? {} : _ref$cssClasses;
+  var highlightAttributeResult = (0, _index.getPropertyByPath)(hit._highlightResult, attribute); // @MAJOR fallback to attribute value if highlight is not found
 
-  var _ref2 = (0, _index.getPropertyByPath)(hit._highlightResult, attribute) || {},
+  process.env.NODE_ENV === 'development' ? (0, _index.warning)(highlightAttributeResult, "Could not enable highlight for \"".concat(attribute, "\", will display an empty string.\nPlease check whether this attribute exists and is either searchable or specified in `attributesToHighlight`.\n\nSee: https://alg.li/highlighting\n")) : void 0;
+
+  var _ref2 = highlightAttributeResult || {},
       _ref2$value = _ref2.value,
       attributeValue = _ref2$value === void 0 ? '' : _ref2$value; // cx is not used, since it would be bundled as a dependency for Vue & Angular
 

package/cjs/helpers/reverseHighlight.js

@@ -18,8 +18,11 @@ function reverseHighlight(_ref) {
       hit = _ref.hit,
       _ref$cssClasses = _ref.cssClasses,
       cssClasses = _ref$cssClasses === void 0 ? {} : _ref$cssClasses;
+  var highlightAttributeResult = (0, _index.getPropertyByPath)(hit._highlightResult, attribute); // @MAJOR fallback to attribute value if highlight is not found
 
-  var _ref2 = (0, _index.getPropertyByPath)(hit._highlightResult, attribute) || {},
+  process.env.NODE_ENV === 'development' ? (0, _index.warning)(highlightAttributeResult, "Could not enable reverse highlight for \"".concat(attribute, "\", will display an empty string.\nPlease check whether this attribute exists and is either searchable or specified in `attributesToHighlight`.\n\nSee: https://alg.li/highlighting\n")) : void 0;
+
+  var _ref2 = highlightAttributeResult || {},
       _ref2$value = _ref2.value,
       attributeValue = _ref2$value === void 0 ? '' : _ref2$value; // cx is not used, since it would be bundled as a dependency for Vue & Angular
 

package/cjs/helpers/reverseSnippet.js

@@ -18,8 +18,11 @@ function reverseSnippet(_ref) {
       hit = _ref.hit,
       _ref$cssClasses = _ref.cssClasses,
       cssClasses = _ref$cssClasses === void 0 ? {} : _ref$cssClasses;
+  var snippetAttributeResult = (0, _index.getPropertyByPath)(hit._snippetResult, attribute); // @MAJOR fallback to attribute value if snippet is not found
 
-  var _ref2 = (0, _index.getPropertyByPath)(hit._snippetResult, attribute) || {},
+  process.env.NODE_ENV === 'development' ? (0, _index.warning)(snippetAttributeResult, "Could not enable reverse snippet for \"".concat(attribute, "\", will display an empty string.\nPlease check whether this attribute exists and is specified in `attributesToSnippet`.\n\nSee: https://alg.li/highlighting\n")) : void 0;
+
+  var _ref2 = snippetAttributeResult || {},
       _ref2$value = _ref2.value,
       attributeValue = _ref2$value === void 0 ? '' : _ref2$value; // cx is not used, since it would be bundled as a dependency for Vue & Angular
 

package/cjs/helpers/snippet.js

@@ -18,8 +18,11 @@ function snippet(_ref) {
       hit = _ref.hit,
       _ref$cssClasses = _ref.cssClasses,
       cssClasses = _ref$cssClasses === void 0 ? {} : _ref$cssClasses;
+  var snippetAttributeResult = (0, _index.getPropertyByPath)(hit._snippetResult, attribute); // @MAJOR fallback to attribute value if snippet is not found
 
-  var _ref2 = (0, _index.getPropertyByPath)(hit._snippetResult, attribute) || {},
+  process.env.NODE_ENV === 'development' ? (0, _index.warning)(snippetAttributeResult, "Could not enable snippet for \"".concat(attribute, "\", will display an empty string.\nPlease check whether this attribute exists and is specified in `attributesToSnippet`.\n\nSee: https://alg.li/highlighting\n")) : void 0;
+
+  var _ref2 = snippetAttributeResult || {},
       _ref2$value = _ref2.value,
       attributeValue = _ref2$value === void 0 ? '' : _ref2$value; // cx is not used, since it would be bundled as a dependency for Vue & Angular
 

package/cjs/lib/version.js

@@ -4,5 +4,5 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-var _default = '4.37.2';
+var _default = '4.37.3';
 exports.default = _default;

package/dist/instantsearch.development.js

@@ -1,4 +1,4 @@
-/*! InstantSearch.js 4.37.2 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch.js */
+/*! InstantSearch.js 4.37.3 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch.js */
 (function (global, factory) {
   typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory() :
   typeof define === 'function' && define.amd ? define(factory) :
@@ -8483,7 +8483,7 @@
     instantSearchInstance.renderState = _objectSpread2(_objectSpread2({}, instantSearchInstance.renderState), {}, _defineProperty({}, parentIndexName, _objectSpread2(_objectSpread2({}, instantSearchInstance.renderState[parentIndexName]), renderState)));
   }
 
-  var version$1 = '4.37.2';
+  var version$1 = '4.37.3';
 
   var NAMESPACE = 'ais';
   var component = function component(componentName) {
@@ -8506,8 +8506,11 @@
         hit = _ref.hit,
         _ref$cssClasses = _ref.cssClasses,
         cssClasses = _ref$cssClasses === void 0 ? {} : _ref$cssClasses;
+    var highlightAttributeResult = getPropertyByPath(hit._highlightResult, attribute); // @MAJOR fallback to attribute value if highlight is not found
 
-    var _ref2 = getPropertyByPath(hit._highlightResult, attribute) || {},
+     _warning(highlightAttributeResult, "Could not enable highlight for \"".concat(attribute, "\", will display an empty string.\nPlease check whether this attribute exists and is either searchable or specified in `attributesToHighlight`.\n\nSee: https://alg.li/highlighting\n")) ;
+
+    var _ref2 = highlightAttributeResult || {},
         _ref2$value = _ref2.value,
         attributeValue = _ref2$value === void 0 ? '' : _ref2$value; // cx is not used, since it would be bundled as a dependency for Vue & Angular
 
@@ -8526,8 +8529,11 @@
         hit = _ref.hit,
         _ref$cssClasses = _ref.cssClasses,
         cssClasses = _ref$cssClasses === void 0 ? {} : _ref$cssClasses;
+    var highlightAttributeResult = getPropertyByPath(hit._highlightResult, attribute); // @MAJOR fallback to attribute value if highlight is not found
+
+     _warning(highlightAttributeResult, "Could not enable reverse highlight for \"".concat(attribute, "\", will display an empty string.\nPlease check whether this attribute exists and is either searchable or specified in `attributesToHighlight`.\n\nSee: https://alg.li/highlighting\n")) ;
 
-    var _ref2 = getPropertyByPath(hit._highlightResult, attribute) || {},
+    var _ref2 = highlightAttributeResult || {},
         _ref2$value = _ref2.value,
         attributeValue = _ref2$value === void 0 ? '' : _ref2$value; // cx is not used, since it would be bundled as a dependency for Vue & Angular
 
@@ -8547,8 +8553,11 @@
         hit = _ref.hit,
         _ref$cssClasses = _ref.cssClasses,
         cssClasses = _ref$cssClasses === void 0 ? {} : _ref$cssClasses;
+    var snippetAttributeResult = getPropertyByPath(hit._snippetResult, attribute); // @MAJOR fallback to attribute value if snippet is not found
 
-    var _ref2 = getPropertyByPath(hit._snippetResult, attribute) || {},
+     _warning(snippetAttributeResult, "Could not enable snippet for \"".concat(attribute, "\", will display an empty string.\nPlease check whether this attribute exists and is specified in `attributesToSnippet`.\n\nSee: https://alg.li/highlighting\n")) ;
+
+    var _ref2 = snippetAttributeResult || {},
         _ref2$value = _ref2.value,
         attributeValue = _ref2$value === void 0 ? '' : _ref2$value; // cx is not used, since it would be bundled as a dependency for Vue & Angular
 
@@ -8567,8 +8576,11 @@
         hit = _ref.hit,
         _ref$cssClasses = _ref.cssClasses,
         cssClasses = _ref$cssClasses === void 0 ? {} : _ref$cssClasses;
+    var snippetAttributeResult = getPropertyByPath(hit._snippetResult, attribute); // @MAJOR fallback to attribute value if snippet is not found
+
+     _warning(snippetAttributeResult, "Could not enable reverse snippet for \"".concat(attribute, "\", will display an empty string.\nPlease check whether this attribute exists and is specified in `attributesToSnippet`.\n\nSee: https://alg.li/highlighting\n")) ;
 
-    var _ref2 = getPropertyByPath(hit._snippetResult, attribute) || {},
+    var _ref2 = snippetAttributeResult || {},
         _ref2$value = _ref2.value,
         attributeValue = _ref2$value === void 0 ? '' : _ref2$value; // cx is not used, since it would be bundled as a dependency for Vue & Angular
 
@@ -13931,6 +13943,9 @@
               state = _ref2.state;
 
           function getItems() {
+            // The hierarchicalFacets condition is required for flavors
+            // that render immediately with empty results, without relying
+            // on init() (like React InstantSearch Hooks).
             if (!results || state.hierarchicalFacets.length === 0) {
               return [];
             }