instantsearch.js 4.66.0 → 4.66.1

package/cjs/connectors/hits/connectHits.js

@@ -108,6 +108,8 @@ var connectHits = function connectHits(renderFn) {
         if (!escapeHTML) {
           return state;
         }
+
+        // @MAJOR: set this globally, not in the Hits widget to allow Hits to be conditionally used
         return state.setQueryParameters(_utils.TAG_PLACEHOLDER);
       }
     };

package/cjs/connectors/infinite-hits/connectInfiniteHits.js

@@ -256,6 +256,7 @@ var connectInfiniteHits = function connectInfiniteHits(renderFn) {
         var uiState = _ref10.uiState;
         var widgetSearchParameters = searchParameters;
         if (escapeHTML) {
+          // @MAJOR: set this globally, not in the InfiniteHits widget to allow InfiniteHits to be conditionally used
           widgetSearchParameters = searchParameters.setQueryParameters(_utils.TAG_PLACEHOLDER);
         }
 

package/cjs/lib/version.js

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

package/dist/instantsearch.development.d.ts

@@ -4243,6 +4243,8 @@ declare type RefinementListRenderState = {
     isFromSearch: boolean;
     /**
      * `true` if a refinement can be applied.
+     * @MAJOR: reconsider how `canRefine` is computed so it both accounts for the
+     * items returned in the main search and in SFFV.
      */
     canRefine: boolean;
     /**

package/dist/instantsearch.development.js

@@ -1,4 +1,4 @@
-/*! InstantSearch.js 4.66.0 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch */
+/*! InstantSearch.js 4.66.1 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch */
 (function (global, factory) {
   typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory() :
   typeof define === 'function' && define.amd ? define(factory) :
@@ -2726,6 +2726,8 @@
           if (!escapeHTML) {
             return state;
           }
+
+          // @MAJOR: set this globally, not in the Hits widget to allow Hits to be conditionally used
           return state.setQueryParameters(TAG_PLACEHOLDER);
         }
       };
@@ -3314,6 +3316,7 @@
           var uiState = _ref10.uiState;
           var widgetSearchParameters = searchParameters;
           if (escapeHTML) {
+            // @MAJOR: set this globally, not in the InfiniteHits widget to allow InfiniteHits to be conditionally used
             widgetSearchParameters = searchParameters.setQueryParameters(TAG_PLACEHOLDER);
           }
 
@@ -6260,6 +6263,42 @@
 
   var omit$1 = _objectWithoutPropertiesLoose$1;
 
+  /**
+   * RecommendParameters is the data structure that contains all the information
+   * usable for getting recommendations from the Algolia API. It doesn't do the
+   * search itself, nor does it contains logic about the parameters.
+   * It is an immutable object, therefore it has been created in a way that each
+   * changes does not change the object itself but returns a copy with the
+   * modification.
+   * This object should probably not be instantiated outside of the helper. It
+   * will be provided when needed.
+   * @constructor
+   * @classdesc contains all the parameters for recommendations
+   * @param {RecommendParametersOptions} opts the options to create the object
+   */
+  function RecommendParameters(opts) {
+    opts = opts || {};
+    this.params = opts.params || [];
+  }
+
+  RecommendParameters.prototype = {
+    constructor: RecommendParameters,
+
+    addParams: function (params) {
+      return new RecommendParameters({ params: this.params.concat(params) });
+    },
+
+    removeParams: function (id) {
+      return new RecommendParameters({
+        params: this.params.filter(function (param) {
+          return param.$$id !== id;
+        }),
+      });
+    },
+  };
+
+  var RecommendParameters_1 = RecommendParameters;
+
   function sortObject(obj) {
     return Object.keys(obj)
       .sort()
@@ -10107,7 +10146,7 @@
 
   var SearchResults_1 = SearchResults;
 
-  var version = '3.16.3';
+  var version = '3.17.0';
 
   var escapeFacetValue$4 = escapeFacetValue_1.escapeFacetValue;
 
@@ -10119,6 +10158,7 @@
 
 
 
+
   /**
    * Event triggered when a parameter is set or updated
    * @event AlgoliaSearchHelper#event:change
@@ -10232,6 +10272,9 @@
     var opts = options || {};
     opts.index = index;
     this.state = SearchParameters_1.make(opts);
+    this.recommendState = new RecommendParameters_1({
+      params: opts.recommendState,
+    });
     this.lastResults = null;
     this._queryId = 0;
     this._lastQueryIdReceived = -1;
@@ -11615,6 +11658,17 @@
     }
   };
 
+  AlgoliaSearchHelper.prototype._recommendChange = function (event) {
+    var state = event.state;
+
+    if (state !== this.recommendState) {
+      this.recommendState = state;
+
+      // eslint-disable-next-line no-warning-comments
+      // TODO: emit "change" event when events for Recommend are implemented
+    }
+  };
+
   /**
    * Clears the cache of the underlying Algolia client.
    * @return {AlgoliaSearchHelper} Method is chainable, it returns itself
@@ -14906,7 +14960,7 @@
     };
   }
 
-  var version$1 = '4.66.0';
+  var version$1 = '4.66.1';
 
   var withUsage$r = createDocumentationMessageGenerator({
     name: 'instantsearch'