instantsearch.js 4.64.0 → 4.64.2

package/dist/instantsearch.production.d.ts

@@ -15,6 +15,7 @@ import type * as Places from 'places.js';
 import type { PlainSearchParameters } from 'algoliasearch-helper';
 import { default as qs_2 } from 'qs';
 import { SearchClient } from 'algoliasearch-helper/types/algoliasearch.js';
+import { SearchOptions } from 'algoliasearch-helper/types/algoliasearch.js';
 import type { SearchParameters } from 'algoliasearch-helper';
 import type { SearchResults } from 'algoliasearch-helper';
 import { VNode } from 'preact';
@@ -2310,6 +2311,7 @@ declare type InfiniteHitsWidgetParams = {
 declare type InitialResult = {
     state: PlainSearchParameters;
     results: SearchResults['_rawResults'];
+    requestParams?: SearchOptions;
 };
 
 declare type InitialResults = Record<string, InitialResult>;
@@ -2455,15 +2457,11 @@ declare class InstantSearch<TUiState extends UiState = UiState, TRouteState = TU
     removeWidgets(widgets: Array<Widget | IndexWidget>): this;
     /**
      * Ends the initialization of InstantSearch.js and triggers the
-     * first search. This method should be called after all widgets have been added
-     * to the instance of InstantSearch.js. InstantSearch.js also supports adding and removing
-     * widgets after the start as an **EXPERIMENTAL** feature.
+     * first search.
      */
     start(): void;
     /**
-     * Removes all widgets without triggering a search afterwards. This is an **EXPERIMENTAL** feature,
-     * if you find an issue with it, please
-     * [open an issue](https://github.com/algolia/instantsearch/issues/new?title=Problem%20with%20dispose).
+     * Removes all widgets without triggering a search afterwards.
      * @return {undefined} This method does not return anything
      */
     dispose(): void;
@@ -4824,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.production.min.d.ts

@@ -15,6 +15,7 @@ import type * as Places from 'places.js';
 import type { PlainSearchParameters } from 'algoliasearch-helper';
 import { default as qs_2 } from 'qs';
 import { SearchClient } from 'algoliasearch-helper/types/algoliasearch.js';
+import { SearchOptions } from 'algoliasearch-helper/types/algoliasearch.js';
 import type { SearchParameters } from 'algoliasearch-helper';
 import type { SearchResults } from 'algoliasearch-helper';
 import { VNode } from 'preact';
@@ -2310,6 +2311,7 @@ declare type InfiniteHitsWidgetParams = {
 declare type InitialResult = {
     state: PlainSearchParameters;
     results: SearchResults['_rawResults'];
+    requestParams?: SearchOptions;
 };
 
 declare type InitialResults = Record<string, InitialResult>;
@@ -2455,15 +2457,11 @@ declare class InstantSearch<TUiState extends UiState = UiState, TRouteState = TU
     removeWidgets(widgets: Array<Widget | IndexWidget>): this;
     /**
      * Ends the initialization of InstantSearch.js and triggers the
-     * first search. This method should be called after all widgets have been added
-     * to the instance of InstantSearch.js. InstantSearch.js also supports adding and removing
-     * widgets after the start as an **EXPERIMENTAL** feature.
+     * first search.
      */
     start(): void;
     /**
-     * Removes all widgets without triggering a search afterwards. This is an **EXPERIMENTAL** feature,
-     * if you find an issue with it, please
-     * [open an issue](https://github.com/algolia/instantsearch/issues/new?title=Problem%20with%20dispose).
+     * Removes all widgets without triggering a search afterwards.
      * @return {undefined} This method does not return anything
      */
     dispose(): void;
@@ -4824,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
      */