instantsearch.js 4.64.1 → 4.64.3

package/cjs/components/SearchBox/SearchBox.js

@@ -29,6 +29,7 @@ var defaultProps = {
   showLoadingIndicator: true,
   autofocus: false,
   searchAsYouType: true,
+  ignoreCompositionEvents: false,
   isSearchStalled: false,
   disabled: false,
   ariaLabel: 'Search',
@@ -58,7 +59,7 @@ var SearchBox = /*#__PURE__*/function (_Component) {
         refine = _this$props.refine,
         onChange = _this$props.onChange;
       var query = event.target.value;
-      if (event.type === 'compositionend' || !event.isComposing) {
+      if (!(_this.props.ignoreCompositionEvents && event.isComposing)) {
         if (searchAsYouType) {
           refine(query);
         }

package/cjs/connectors/autocomplete/connectAutocomplete.js

@@ -69,7 +69,9 @@ var connectAutocomplete = function connectAutocomplete(renderFn) {
           scopedResult.results.hits = escapeHTML ? (0, _utils.escapeHits)(scopedResult.results.hits) : scopedResult.results.hits;
           var sendEvent = (0, _utils.createSendEventForHits)({
             instantSearchInstance: instantSearchInstance,
-            index: scopedResult.results.index,
+            getIndex: function getIndex() {
+              return scopedResult.results.index;
+            },
             widgetType: _this.$$type
           });
           return {

package/cjs/connectors/geo-search/connectGeoSearch.js

@@ -155,7 +155,9 @@ var connectGeoSearch = function connectGeoSearch(renderFn) {
         if (!sendEvent) {
           sendEvent = (0, _utils.createSendEventForHits)({
             instantSearchInstance: instantSearchInstance,
-            index: helper.getIndex(),
+            getIndex: function getIndex() {
+              return helper.getIndex();
+            },
             widgetType: $$type
           });
         }

package/cjs/connectors/hits/connectHits.js

@@ -54,13 +54,17 @@ var connectHits = function connectHits(renderFn) {
         if (!sendEvent) {
           sendEvent = (0, _utils.createSendEventForHits)({
             instantSearchInstance: instantSearchInstance,
-            index: helper.getIndex(),
+            getIndex: function getIndex() {
+              return helper.getIndex();
+            },
             widgetType: this.$$type
           });
         }
         if (!bindEvent) {
           bindEvent = (0, _utils.createBindEventForHits)({
-            index: helper.getIndex(),
+            getIndex: function getIndex() {
+              return helper.getIndex();
+            },
             widgetType: this.$$type,
             instantSearchInstance: instantSearchInstance
           });

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

@@ -161,11 +161,15 @@ var connectInfiniteHits = function connectInfiniteHits(renderFn) {
           showMore = getShowMore(helper);
           sendEvent = (0, _utils.createSendEventForHits)({
             instantSearchInstance: instantSearchInstance,
-            index: helper.getIndex(),
+            getIndex: function getIndex() {
+              return helper.getIndex();
+            },
             widgetType: this.$$type
           });
           bindEvent = (0, _utils.createBindEventForHits)({
-            index: helper.getIndex(),
+            getIndex: function getIndex() {
+              return helper.getIndex();
+            },
             widgetType: this.$$type,
             instantSearchInstance: instantSearchInstance
           });

package/cjs/lib/utils/createSendEventForHits.js

@@ -28,7 +28,7 @@ function chunk(arr) {
   return chunks;
 }
 function _buildEventPayloadsForHits(_ref) {
-  var index = _ref.index,
+  var getIndex = _ref.getIndex,
     widgetType = _ref.widgetType,
     methodName = _ref.methodName,
     args = _ref.args,
@@ -85,7 +85,7 @@ function _buildEventPayloadsForHits(_ref) {
         eventType: eventType,
         payload: _objectSpread({
           eventName: eventName || 'Hits Viewed',
-          index: index,
+          index: getIndex(),
           objectIDs: objectIDsByChunk[i]
         }, additionalData),
         hits: batch,
@@ -100,7 +100,7 @@ function _buildEventPayloadsForHits(_ref) {
         eventType: eventType,
         payload: _objectSpread({
           eventName: eventName || 'Hit Clicked',
-          index: index,
+          index: getIndex(),
           queryID: queryID,
           objectIDs: objectIDsByChunk[i],
           positions: positionsByChunk[i]
@@ -117,7 +117,7 @@ function _buildEventPayloadsForHits(_ref) {
         eventType: eventType,
         payload: _objectSpread({
           eventName: eventName || 'Hit Converted',
-          index: index,
+          index: getIndex(),
           queryID: queryID,
           objectIDs: objectIDsByChunk[i]
         }, additionalData),
@@ -133,7 +133,7 @@ function _buildEventPayloadsForHits(_ref) {
 }
 function createSendEventForHits(_ref2) {
   var instantSearchInstance = _ref2.instantSearchInstance,
-    index = _ref2.index,
+    getIndex = _ref2.getIndex,
     widgetType = _ref2.widgetType;
   var sentEvents = {};
   var timer = undefined;
@@ -143,7 +143,7 @@ function createSendEventForHits(_ref2) {
     }
     var payloads = _buildEventPayloadsForHits({
       widgetType: widgetType,
-      index: index,
+      getIndex: getIndex,
       methodName: 'sendEvent',
       args: args,
       instantSearchInstance: instantSearchInstance
@@ -163,7 +163,7 @@ function createSendEventForHits(_ref2) {
   return sendEventForHits;
 }
 function createBindEventForHits(_ref3) {
-  var index = _ref3.index,
+  var getIndex = _ref3.getIndex,
     widgetType = _ref3.widgetType,
     instantSearchInstance = _ref3.instantSearchInstance;
   var bindEventForHits = function bindEventForHits() {
@@ -172,7 +172,7 @@ function createBindEventForHits(_ref3) {
     }
     var payloads = _buildEventPayloadsForHits({
       widgetType: widgetType,
-      index: index,
+      getIndex: getIndex,
       methodName: 'bindEvent',
       args: args,
       instantSearchInstance: instantSearchInstance

package/cjs/lib/version.js

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

package/cjs/widgets/search-box/search-box.js

@@ -29,6 +29,7 @@ var renderer = function renderer(_ref) {
     templates = _ref.templates,
     autofocus = _ref.autofocus,
     searchAsYouType = _ref.searchAsYouType,
+    ignoreCompositionEvents = _ref.ignoreCompositionEvents,
     showReset = _ref.showReset,
     showSubmit = _ref.showSubmit,
     showLoadingIndicator = _ref.showLoadingIndicator;
@@ -42,6 +43,7 @@ var renderer = function renderer(_ref) {
       autofocus: autofocus,
       refine: refine,
       searchAsYouType: searchAsYouType,
+      ignoreCompositionEvents: ignoreCompositionEvents,
       templates: templates,
       showSubmit: showSubmit,
       showReset: showReset,
@@ -72,6 +74,8 @@ var searchBox = function searchBox(widgetParams) {
     autofocus = _ref3$autofocus === void 0 ? false : _ref3$autofocus,
     _ref3$searchAsYouType = _ref3.searchAsYouType,
     searchAsYouType = _ref3$searchAsYouType === void 0 ? true : _ref3$searchAsYouType,
+    _ref3$ignoreCompositi = _ref3.ignoreCompositionEvents,
+    ignoreCompositionEvents = _ref3$ignoreCompositi === void 0 ? false : _ref3$ignoreCompositi,
     _ref3$showReset = _ref3.showReset,
     showReset = _ref3$showReset === void 0 ? true : _ref3$showReset,
     _ref3$showSubmit = _ref3.showSubmit,
@@ -120,6 +124,7 @@ var searchBox = function searchBox(widgetParams) {
     templates: templates,
     autofocus: autofocus,
     searchAsYouType: searchAsYouType,
+    ignoreCompositionEvents: ignoreCompositionEvents,
     showReset: showReset,
     showSubmit: showSubmit,
     showLoadingIndicator: showLoadingIndicator

package/dist/instantsearch.development.d.ts

@@ -4822,6 +4822,12 @@ declare type SearchBoxWidgetParams = {
      * once `<Enter>` is pressed only.
      */
     searchAsYouType?: boolean;
+    /**
+     * Whether to update the search state in the middle of a
+     * composition session.
+     * @default false
+     */
+    ignoreCompositionEvents?: boolean;
     /**
      * Whether to show the reset button
      */

package/dist/instantsearch.development.js

@@ -1,4 +1,4 @@
-/*! InstantSearch.js 4.64.1 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch */
+/*! InstantSearch.js 4.64.3 | © 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) :
@@ -801,7 +801,7 @@
     return chunks;
   }
   function _buildEventPayloadsForHits(_ref) {
-    var index = _ref.index,
+    var getIndex = _ref.getIndex,
       widgetType = _ref.widgetType,
       methodName = _ref.methodName,
       args = _ref.args,
@@ -854,7 +854,7 @@
           eventType: eventType,
           payload: _objectSpread2({
             eventName: eventName || 'Hits Viewed',
-            index: index,
+            index: getIndex(),
             objectIDs: objectIDsByChunk[i]
           }, additionalData),
           hits: batch,
@@ -869,7 +869,7 @@
           eventType: eventType,
           payload: _objectSpread2({
             eventName: eventName || 'Hit Clicked',
-            index: index,
+            index: getIndex(),
             queryID: queryID,
             objectIDs: objectIDsByChunk[i],
             positions: positionsByChunk[i]
@@ -886,7 +886,7 @@
           eventType: eventType,
           payload: _objectSpread2({
             eventName: eventName || 'Hit Converted',
-            index: index,
+            index: getIndex(),
             queryID: queryID,
             objectIDs: objectIDsByChunk[i]
           }, additionalData),
@@ -900,7 +900,7 @@
   }
   function createSendEventForHits(_ref2) {
     var instantSearchInstance = _ref2.instantSearchInstance,
-      index = _ref2.index,
+      getIndex = _ref2.getIndex,
       widgetType = _ref2.widgetType;
     var sentEvents = {};
     var timer = undefined;
@@ -910,7 +910,7 @@
       }
       var payloads = _buildEventPayloadsForHits({
         widgetType: widgetType,
-        index: index,
+        getIndex: getIndex,
         methodName: 'sendEvent',
         args: args,
         instantSearchInstance: instantSearchInstance
@@ -930,7 +930,7 @@
     return sendEventForHits;
   }
   function createBindEventForHits(_ref3) {
-    var index = _ref3.index,
+    var getIndex = _ref3.getIndex,
       widgetType = _ref3.widgetType,
       instantSearchInstance = _ref3.instantSearchInstance;
     var bindEventForHits = function bindEventForHits() {
@@ -939,7 +939,7 @@
       }
       var payloads = _buildEventPayloadsForHits({
         widgetType: widgetType,
-        index: index,
+        getIndex: getIndex,
         methodName: 'bindEvent',
         args: args,
         instantSearchInstance: instantSearchInstance
@@ -2669,13 +2669,17 @@
           if (!sendEvent) {
             sendEvent = createSendEventForHits({
               instantSearchInstance: instantSearchInstance,
-              index: helper.getIndex(),
+              getIndex: function getIndex() {
+                return helper.getIndex();
+              },
               widgetType: this.$$type
             });
           }
           if (!bindEvent) {
             bindEvent = createBindEventForHits({
-              index: helper.getIndex(),
+              getIndex: function getIndex() {
+                return helper.getIndex();
+              },
               widgetType: this.$$type,
               instantSearchInstance: instantSearchInstance
             });
@@ -3212,11 +3216,15 @@
             showMore = getShowMore(helper);
             sendEvent = createSendEventForHits({
               instantSearchInstance: instantSearchInstance,
-              index: helper.getIndex(),
+              getIndex: function getIndex() {
+                return helper.getIndex();
+              },
               widgetType: this.$$type
             });
             bindEvent = createBindEventForHits({
-              index: helper.getIndex(),
+              getIndex: function getIndex() {
+                return helper.getIndex();
+              },
               widgetType: this.$$type,
               instantSearchInstance: instantSearchInstance
             });
@@ -5651,7 +5659,9 @@
           if (!sendEvent) {
             sendEvent = createSendEventForHits({
               instantSearchInstance: instantSearchInstance,
-              index: helper.getIndex(),
+              getIndex: function getIndex() {
+                return helper.getIndex();
+              },
               widgetType: $$type$4
             });
           }
@@ -11976,7 +11986,9 @@
             scopedResult.results.hits = escapeHTML ? escapeHits(scopedResult.results.hits) : scopedResult.results.hits;
             var sendEvent = createSendEventForHits({
               instantSearchInstance: instantSearchInstance,
-              index: scopedResult.results.index,
+              getIndex: function getIndex() {
+                return scopedResult.results.index;
+              },
               widgetType: _this.$$type
             });
             return {
@@ -14890,7 +14902,7 @@
     };
   }
 
-  var version$1 = '4.64.1';
+  var version$1 = '4.64.3';
 
   var withUsage$r = createDocumentationMessageGenerator({
     name: 'instantsearch'
@@ -18039,6 +18051,7 @@
     showLoadingIndicator: true,
     autofocus: false,
     searchAsYouType: true,
+    ignoreCompositionEvents: false,
     isSearchStalled: false,
     disabled: false,
     ariaLabel: 'Search',
@@ -18068,7 +18081,7 @@
           refine = _this$props.refine,
           onChange = _this$props.onChange;
         var query = event.target.value;
-        if (event.type === 'compositionend' || !event.isComposing) {
+        if (!(_this.props.ignoreCompositionEvents && event.isComposing)) {
           if (searchAsYouType) {
             refine(query);
           }
@@ -21826,6 +21839,7 @@
       templates = _ref.templates,
       autofocus = _ref.autofocus,
       searchAsYouType = _ref.searchAsYouType,
+      ignoreCompositionEvents = _ref.ignoreCompositionEvents,
       showReset = _ref.showReset,
       showSubmit = _ref.showSubmit,
       showLoadingIndicator = _ref.showLoadingIndicator;
@@ -21839,6 +21853,7 @@
         autofocus: autofocus,
         refine: refine,
         searchAsYouType: searchAsYouType,
+        ignoreCompositionEvents: ignoreCompositionEvents,
         templates: templates,
         showSubmit: showSubmit,
         showReset: showReset,
@@ -21869,6 +21884,8 @@
       autofocus = _ref3$autofocus === void 0 ? false : _ref3$autofocus,
       _ref3$searchAsYouType = _ref3.searchAsYouType,
       searchAsYouType = _ref3$searchAsYouType === void 0 ? true : _ref3$searchAsYouType,
+      _ref3$ignoreCompositi = _ref3.ignoreCompositionEvents,
+      ignoreCompositionEvents = _ref3$ignoreCompositi === void 0 ? false : _ref3$ignoreCompositi,
       _ref3$showReset = _ref3.showReset,
       showReset = _ref3$showReset === void 0 ? true : _ref3$showReset,
       _ref3$showSubmit = _ref3.showSubmit,
@@ -21917,6 +21934,7 @@
       templates: templates,
       autofocus: autofocus,
       searchAsYouType: searchAsYouType,
+      ignoreCompositionEvents: ignoreCompositionEvents,
       showReset: showReset,
       showSubmit: showSubmit,
       showLoadingIndicator: showLoadingIndicator