instantsearch.js 4.39.0 → 4.40.0

package/CHANGELOG.md

@@ -1,3 +1,30 @@
+# [4.40.0](https://github.com/algolia/instantsearch.js/compare/v4.39.2...v4.40.0) (2022-03-21)
+
+
+### Features
+
+* **infiniteHits:** avoid caching artificial results ([#5023](https://github.com/algolia/instantsearch.js/issues/5023)) ([e8c0145](https://github.com/algolia/instantsearch.js/commit/e8c01452ebe77b82b8a107c5d4fc026abf5645d8))
+
+
+
+## [4.39.2](https://github.com/algolia/instantsearch.js/compare/v4.39.1...v4.39.2) (2022-03-14)
+
+
+### Bug Fixes
+
+* fix types of `sortBy` option ([#5024](https://github.com/algolia/instantsearch.js/issues/5024)) ([3f7ea32](https://github.com/algolia/instantsearch.js/commit/3f7ea32374e0e409ebf27b07d28cf3871a5b33b3))
+
+
+
+## [4.39.1](https://github.com/algolia/instantsearch.js/compare/v4.39.0...v4.39.1) (2022-03-01)
+
+
+### Bug Fixes
+
+* **insights:** send view events after rendering ([#5014](https://github.com/algolia/instantsearch.js/issues/5014)) ([e952abc](https://github.com/algolia/instantsearch.js/commit/e952abc64043a55e06c9c46a656bc98ad45d1502))
+
+
+
 # [4.39.0](https://github.com/algolia/instantsearch.js/compare/v4.38.1...v4.39.0) (2022-02-23)
 
 

package/cjs/connectors/hits/connectHits.js

@@ -41,10 +41,10 @@ var connectHits = function connectHits(renderFn) {
       },
       render: function render(renderOptions) {
         var renderState = this.getWidgetRenderState(renderOptions);
-        renderState.sendEvent('view', renderState.hits);
         renderFn(_objectSpread(_objectSpread({}, renderState), {}, {
           instantSearchInstance: renderOptions.instantSearchInstance
         }), false);
+        renderState.sendEvent('view', renderState.hits);
       },
       getRenderState: function getRenderState(renderState, renderOptions) {
         return _objectSpread(_objectSpread({}, renderState), {}, {

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

@@ -141,10 +141,10 @@ var connectInfiniteHits = function connectInfiniteHits(renderFn) {
       render: function render(renderOptions) {
         var instantSearchInstance = renderOptions.instantSearchInstance;
         var widgetRenderState = this.getWidgetRenderState(renderOptions);
-        sendEvent('view', widgetRenderState.currentPageHits);
         renderFn(_objectSpread(_objectSpread({}, widgetRenderState), {}, {
           instantSearchInstance: instantSearchInstance
         }), false);
+        sendEvent('view', widgetRenderState.currentPageHits);
       },
       getRenderState: function getRenderState(renderState, renderOptions) {
         return _objectSpread(_objectSpread({}, renderState), {}, {
@@ -189,7 +189,7 @@ var connectInfiniteHits = function connectInfiniteHits(renderFn) {
             results: results
           });
 
-          if (cachedHits[_page] === undefined) {
+          if (cachedHits[_page] === undefined && !results.__isArtificial) {
             cachedHits[_page] = transformedHits;
             cache.write({
               state: state,

package/cjs/lib/version.js

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

package/dist/instantsearch.development.d.ts

@@ -1472,7 +1472,7 @@ declare type HierarchicalMenuConnectorParams = {
      *
      * If a facetOrdering is set in the index settings, it is used when sortBy isn't passed
      */
-    sortBy?: SortBy<HierarchicalMenuItem>;
+    sortBy?: SortBy<SearchResults.HierarchicalFacet>;
     /**
      * Function to transform the items passed to the templates.
      */
@@ -2533,7 +2533,7 @@ declare type MenuConnectorParams = {
      *
      * If a facetOrdering is set in the index settings, it is used when sortBy isn't passed
      */
-    sortBy?: SortBy<MenuItem>;
+    sortBy?: SortBy<SearchResults.HierarchicalFacet>;
     /**
      * Function to transform the items passed to the templates.
      */
@@ -3877,7 +3877,7 @@ declare type RefinementListConnectorParams = {
      *
      * If a facetOrdering is set in the index settings, it is used when sortBy isn't passed
      */
-    sortBy?: SortBy<RefinementListItem>;
+    sortBy?: SortBy<SearchResults.FacetValue>;
     /**
      * Escapes the content of the facet values.
      */
@@ -4627,7 +4627,7 @@ declare type SnippetOptions = {
 /**
  * Transforms the given items.
  */
-declare type SortBy<TItem> = ((a: TItem, b: TItem) => number) | Array<'count' | 'isRefined' | 'name:asc' | 'name:desc'>;
+declare type SortBy<TItem> = ((a: TItem, b: TItem) => number) | Array<SortByDirection<'count' | 'name' | 'isRefined'>>;
 
 /**
  * Sort by selector is a widget used for letting the user choose between different
@@ -4648,6 +4648,8 @@ declare type SortByConnectorParams = {
     transformItems?: TransformItems<SortByItem>;
 };
 
+declare type SortByDirection<TCriterion extends string> = TCriterion | `${TCriterion}:asc` | `${TCriterion}:desc`;
+
 declare type SortByIndexDefinition = {
     /**
      * The name of the index to target.

package/dist/instantsearch.development.js

@@ -1,4 +1,4 @@
-/*! InstantSearch.js 4.39.0 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch.js */
+/*! InstantSearch.js 4.40.0 | © 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) :
@@ -2656,7 +2656,7 @@
   }
    **/
   /*eslint-enable */
-  function SearchResults(state, results) {
+  function SearchResults(state, results, options) {
     var mainSubResponse = results[0];
 
     this._rawResults = results;
@@ -2668,6 +2668,11 @@
       self[key] = mainSubResponse[key];
     });
 
+    // Make every key of the result options reachable from the instance
+    Object.keys(options || {}).forEach(function(key) {
+      self[key] = options[key];
+    });
+
     /**
      * query used to generate the results
      * @name query
@@ -4115,7 +4120,7 @@
 
   var requestBuilder_1 = requestBuilder;
 
-  var version = '3.7.0';
+  var version = '3.7.3';
 
   /**
    * Event triggered when a parameter is set or updated
@@ -8483,7 +8488,7 @@
     instantSearchInstance.renderState = _objectSpread2(_objectSpread2({}, instantSearchInstance.renderState), {}, _defineProperty({}, parentIndexName, _objectSpread2(_objectSpread2({}, instantSearchInstance.renderState[parentIndexName]), renderState)));
   }
 
-  var version$1 = '4.39.0';
+  var version$1 = '4.40.0';
 
   var NAMESPACE = 'ais';
   var component = function component(componentName) {
@@ -11092,10 +11097,10 @@
         },
         render: function render(renderOptions) {
           var renderState = this.getWidgetRenderState(renderOptions);
-          renderState.sendEvent('view', renderState.hits);
           renderFn(_objectSpread2(_objectSpread2({}, renderState), {}, {
             instantSearchInstance: renderOptions.instantSearchInstance
           }), false);
+          renderState.sendEvent('view', renderState.hits);
         },
         getRenderState: function getRenderState(renderState, renderOptions) {
           return _objectSpread2(_objectSpread2({}, renderState), {}, {
@@ -11619,10 +11624,10 @@
         render: function render(renderOptions) {
           var instantSearchInstance = renderOptions.instantSearchInstance;
           var widgetRenderState = this.getWidgetRenderState(renderOptions);
-          sendEvent('view', widgetRenderState.currentPageHits);
           renderFn(_objectSpread2(_objectSpread2({}, widgetRenderState), {}, {
             instantSearchInstance: instantSearchInstance
           }), false);
+          sendEvent('view', widgetRenderState.currentPageHits);
         },
         getRenderState: function getRenderState(renderState, renderOptions) {
           return _objectSpread2(_objectSpread2({}, renderState), {}, {
@@ -11667,7 +11672,7 @@
               results: results
             });
 
-            if (cachedHits[_page] === undefined) {
+            if (cachedHits[_page] === undefined && !results.__isArtificial) {
               cachedHits[_page] = transformedHits;
               cache.write({
                 state: state,