instantsearch.js 4.49.4 → 4.50.0

package/es/components/Pagination/Pagination.js

@@ -38,7 +38,7 @@ function Pagination(props) {
   }), props.pages.map(function (pageNumber) {
     return h(PaginationLink, {
       key: pageNumber,
-      ariaLabel: "".concat(pageNumber + 1),
+      ariaLabel: "Page ".concat(pageNumber + 1),
       className: props.cssClasses.pageItem,
       isSelected: pageNumber === props.currentPage,
       label: "".concat(pageNumber + 1),

package/es/connectors/hits/connectHits.js

@@ -55,7 +55,8 @@ var connectHits = function connectHits(renderFn) {
         if (!bindEvent) {
           bindEvent = createBindEventForHits({
             index: helper.getIndex(),
-            widgetType: this.$$type
+            widgetType: this.$$type,
+            instantSearchInstance: instantSearchInstance
           });
         }
         if (!results) {

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

@@ -145,7 +145,8 @@ var connectInfiniteHits = function connectInfiniteHits(renderFn) {
           });
           bindEvent = createBindEventForHits({
             index: helper.getIndex(),
-            widgetType: this.$$type
+            widgetType: this.$$type,
+            instantSearchInstance: instantSearchInstance
           });
           isFirstPage = state.page === undefined || getFirstReceivedPage(state, cachedHits) === 0;
         } else {
@@ -159,7 +160,7 @@ var connectInfiniteHits = function connectInfiniteHits(renderFn) {
           var transformedHits = transformItems(hitsWithAbsolutePositionAndQueryID, {
             results: results
           });
-          if (cachedHits[_page] === undefined && !results.__isArtificial) {
+          if (cachedHits[_page] === undefined && !results.__isArtificial && instantSearchInstance.status === 'idle') {
             cachedHits[_page] = transformedHits;
             cache.write({
               state: state,

package/es/lib/InstantSearch.js

@@ -73,8 +73,9 @@ var InstantSearch = /*#__PURE__*/function (_EventEmitter) {
       }
     }));
     _defineProperty(_assertThisInitialized(_this), "scheduleRender", defer(function () {
+      var _this$mainHelper;
       var shouldResetStatus = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : true;
-      if (!_this.mainHelper.hasPendingRequests()) {
+      if (!((_this$mainHelper = _this.mainHelper) !== null && _this$mainHelper !== void 0 && _this$mainHelper.hasPendingRequests())) {
         clearTimeout(_this._searchStalledTimer);
         _this._searchStalledTimer = null;
         if (shouldResetStatus) {
@@ -342,12 +343,7 @@ var InstantSearch = /*#__PURE__*/function (_EventEmitter) {
       var mainHelper = this.mainHelper || algoliasearchHelper(this.client, this.indexName);
       mainHelper.search = function () {
         _this3.status = 'loading';
-        // @MAJOR: use scheduleRender here
-        // For now, widgets don't expect to be rendered at the start of `loading`,
-        // so it would be a breaking change to add an extra render. We don't have
-        // these guarantees about the render event, thus emitting it once more
-        // isn't a breaking change.
-        _this3.emit('render');
+        _this3.scheduleRender(false);
 
         // This solution allows us to keep the exact same API for the users but
         // under the hood, we have a different implementation. It should be

package/es/lib/templating/renderTemplate.js

@@ -50,6 +50,9 @@ export function renderTemplate(_ref) {
       Snippet: Snippet,
       ReverseSnippet: ReverseSnippet
     };
+
+    // @MAJOR remove the `as any` when string templates are removed
+    // needed because not every template receives sendEvent
     return template(data, params);
   }
   var transformedHelpers = transformHelpersToHogan(helpers, compileOptions, data);

package/es/lib/utils/createSendEventForHits.d.ts

@@ -2,16 +2,17 @@ import type { InstantSearch, Hit } from '../../types';
 declare type BuiltInSendEventForHits = (eventType: string, hits: Hit | Hit[], eventName?: string) => void;
 declare type CustomSendEventForHits = (customPayload: any) => void;
 export declare type SendEventForHits = BuiltInSendEventForHits & CustomSendEventForHits;
-declare type BuiltInBindEventForHits = (eventType: string, hits: Hit | Hit[], eventName?: string) => string;
-declare type CustomBindEventForHits = (customPayload: any) => string;
+export declare type BuiltInBindEventForHits = (eventType: string, hits: Hit | Hit[], eventName?: string) => string;
+export declare type CustomBindEventForHits = (customPayload: any) => string;
 export declare type BindEventForHits = BuiltInBindEventForHits & CustomBindEventForHits;
 export declare function createSendEventForHits({ instantSearchInstance, index, widgetType, }: {
     instantSearchInstance: InstantSearch;
     index: string;
     widgetType: string;
 }): SendEventForHits;
-export declare function createBindEventForHits({ index, widgetType, }: {
+export declare function createBindEventForHits({ index, widgetType, instantSearchInstance, }: {
     index: string;
     widgetType: string;
+    instantSearchInstance: InstantSearch;
 }): BindEventForHits;
 export {};

package/es/lib/utils/createSendEventForHits.js

@@ -13,7 +13,7 @@ var buildPayloads = function buildPayloads(_ref) {
     widgetType = _ref.widgetType,
     methodName = _ref.methodName,
     args = _ref.args,
-    isSearchStalled = _ref.isSearchStalled;
+    instantSearchInstance = _ref.instantSearchInstance;
   // when there's only one argument, that means it's custom
   if (args.length === 1 && _typeof(args[0]) === 'object') {
     return [args[0]];
@@ -52,7 +52,7 @@ var buildPayloads = function buildPayloads(_ref) {
     });
   });
   if (eventType === 'view') {
-    if (isSearchStalled) {
+    if (instantSearchInstance.status !== 'idle') {
       return [];
     }
     return hitsChunks.map(function (batch, i) {
@@ -122,7 +122,7 @@ export function createSendEventForHits(_ref2) {
       index: index,
       methodName: 'sendEvent',
       args: args,
-      isSearchStalled: instantSearchInstance.status === 'stalled'
+      instantSearchInstance: instantSearchInstance
     });
     payloads.forEach(function (payload) {
       return instantSearchInstance.sendEventToInsights(payload);
@@ -132,7 +132,8 @@ export function createSendEventForHits(_ref2) {
 }
 export function createBindEventForHits(_ref3) {
   var index = _ref3.index,
-    widgetType = _ref3.widgetType;
+    widgetType = _ref3.widgetType,
+    instantSearchInstance = _ref3.instantSearchInstance;
   var bindEventForHits = function bindEventForHits() {
     for (var _len2 = arguments.length, args = new Array(_len2), _key2 = 0; _key2 < _len2; _key2++) {
       args[_key2] = arguments[_key2];
@@ -142,7 +143,7 @@ export function createBindEventForHits(_ref3) {
       index: index,
       methodName: 'bindEvent',
       args: args,
-      isSearchStalled: false
+      instantSearchInstance: instantSearchInstance
     });
     return payloads.length ? "data-insights-event=".concat(serializePayload(payloads)) : '';
   };

package/es/lib/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "4.49.4";
+declare const _default: "4.50.0";
 export default _default;

package/es/lib/version.js

@@ -1 +1 @@
-export default '4.49.4';
+export default '4.50.0';

package/es/types/templates.d.ts

@@ -1,9 +1,9 @@
 import type { VNode } from 'preact';
 import type { Highlight, ReverseHighlight, ReverseSnippet, Snippet } from '../helpers/components';
 import type { html } from 'htm/preact';
-import type { BindEventForHits, SendEventForHits } from '../lib/utils';
+import type { BuiltInBindEventForHits, CustomBindEventForHits, SendEventForHits } from '../lib/utils';
 export declare type Template<TTemplateData = void> = string | ((data: TTemplateData, params: TemplateParams) => VNode | VNode[] | string);
-export declare type TemplateParams = BindEventForHits & {
+export declare type TemplateParams = {
     html: typeof html;
     components: {
         Highlight: typeof Highlight;
@@ -13,8 +13,16 @@ export declare type TemplateParams = BindEventForHits & {
     };
     sendEvent?: SendEventForHits;
 };
-export declare type TemplateWithBindEvent<TTemplateData = void> = string | ((data: TTemplateData, params: TemplateParams) => VNode | VNode[] | string);
+interface TemplateWithBindEventParams extends TemplateParams {
+    /** @deprecated use sendEvent instead */
+    (...args: Parameters<BuiltInBindEventForHits>): ReturnType<BuiltInBindEventForHits>;
+    /** @deprecated use sendEvent instead */
+    (...args: Parameters<CustomBindEventForHits>): ReturnType<CustomBindEventForHits>;
+    sendEvent: SendEventForHits;
+}
+export declare type TemplateWithBindEvent<TTemplateData = void> = string | ((data: TTemplateData, params: TemplateWithBindEventParams) => VNode | VNode[] | string);
 export declare type Templates = {
     [key: string]: Template<any> | TemplateWithBindEvent<any> | undefined;
 };
 export declare type HoganHelpers<TKeys extends string = string> = Record<TKeys, (text: string, render: (value: string) => string) => string>;
+export {};

package/es/widgets/index/index.js

@@ -101,6 +101,7 @@ var index = function index(widgetParams) {
   var localParent = null;
   var helper = null;
   var derivedHelper = null;
+  var lastValidSearchParameters = null;
   return {
     $$type: 'ais.index',
     $$widgetType: 'ais.index',
@@ -114,7 +115,16 @@ var index = function index(widgetParams) {
       return helper;
     },
     getResults: function getResults() {
-      return derivedHelper && derivedHelper.lastResults;
+      var _derivedHelper;
+      if (!((_derivedHelper = derivedHelper) !== null && _derivedHelper !== void 0 && _derivedHelper.lastResults)) return null;
+
+      // To make the UI optimistic, we patch the state to display to the current
+      // one instead of the one associated with the latest results.
+      // This means user-driven UI changes (e.g., checked checkbox) are reflected
+      // immediately instead of waiting for Algolia to respond, regardless of
+      // the status of the network request.
+      derivedHelper.lastResults._state = helper.state;
+      return derivedHelper.lastResults;
     },
     getScopedResults: function getScopedResults() {
       var widgetParent = this.getParent();
@@ -319,6 +329,7 @@ var index = function index(widgetParams) {
         // does not have access to lastResults, which it used to in pre-federated
         // search behavior.
         helper.lastResults = results;
+        lastValidSearchParameters = results._state;
       });
 
       // We compute the render state before calling `init` in a separate loop
@@ -377,6 +388,12 @@ var index = function index(widgetParams) {
       if (!this.getResults()) {
         return;
       }
+
+      // we can't attach a listener to the error event of search, as the error
+      // then would no longer be thrown for global handlers.
+      if (instantSearchInstance.status === 'error' && !instantSearchInstance.mainHelper.hasPendingRequests()) {
+        helper.setState(lastValidSearchParameters);
+      }
       localWidgets.forEach(function (widget) {
         if (widget.getRenderState) {
           var renderState = widget.getRenderState(instantSearchInstance.renderState[_this4.getIndexId()] || {}, createRenderArgs(instantSearchInstance, _this4));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "instantsearch.js",
-  "version": "4.49.4",
+  "version": "4.50.0",
   "description": "InstantSearch.js is a JavaScript library for building performant and instant search experiences with Algolia.",
   "homepage": "https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/js/",
   "types": "es/index.d.ts",
@@ -32,7 +32,7 @@
     "@types/google.maps": "^3.45.3",
     "@types/hogan.js": "^3.0.0",
     "@types/qs": "^6.5.3",
-    "algoliasearch-helper": "^3.11.2",
+    "algoliasearch-helper": "^3.11.3",
     "hogan.js": "^3.0.2",
     "htm": "^3.0.0",
     "preact": "^10.10.0",
@@ -54,8 +54,9 @@
     "version": "./scripts/version/update-version.js"
   },
   "devDependencies": {
-    "@instantsearch/mocks": "1.0.3",
-    "@instantsearch/testutils": "1.0.3",
+    "@instantsearch/mocks": "1.1.0",
+    "@instantsearch/tests": "1.1.0",
+    "@instantsearch/testutils": "1.0.4",
     "@storybook/html": "5.3.9",
     "@types/scriptjs": "0.0.2",
     "algoliasearch": "4.14.3",
@@ -63,5 +64,5 @@
     "scriptjs": "2.5.9",
     "webpack": "4.41.5"
   },
-  "gitHead": "4c473604508a865a2488e064fdd3a415f416d14a"
+  "gitHead": "15adccb907fec9528ab169ee3d7d905ceab5a860"
 }