instantsearch.js 4.75.6 → 4.76.0

package/dist/instantsearch.production.d.ts

@@ -1,6 +1,7 @@
 import { AlgoliaSearchHelper } from 'algoliasearch-helper';
 import { Banner } from 'algoliasearch-helper';
 import type { CarouselProps } from 'instantsearch-ui-components';
+import { CompositionClient } from 'algoliasearch-helper/types/algoliasearch.js';
 import EventEmitter from '@algolia/events';
 import { FindAnswersOptions } from 'algoliasearch-helper/types/algoliasearch.js';
 import type { FrequentlyBoughtTogetherProps } from 'instantsearch-ui-components';
@@ -5047,6 +5048,7 @@ declare type InsightsProps<TInsightsClient extends ProvidedInsightsClient = Prov
 declare class InstantSearch<TUiState extends UiState = UiState, TRouteState = TUiState> extends EventEmitter {
     client: InstantSearchOptions['searchClient'];
     indexName: string;
+    compositionID?: string;
     insightsClient: InsightsClient | null;
     onStateChange: InstantSearchOptions<TUiState>['onStateChange'] | null;
     future: NonNullable<InstantSearchOptions<TUiState>['future']>;
@@ -5208,6 +5210,12 @@ declare type InstantSearchOptions<TUiState extends UiState = UiState, TRouteStat
      * The name of the main index. If no indexName is provided, you have to manually add an index widget.
      */
     indexName?: string;
+    /**
+     * The objectID of the composition.
+     * If this is passed, the composition API will be used for search.
+     * Multi-index search is not supported with this option.
+     */
+    compositionID?: string;
     /**
      * The search client to plug to InstantSearch.js
      *
@@ -5235,7 +5243,7 @@ declare type InstantSearchOptions<TUiState extends UiState = UiState, TRouteStat
      * });
      * ```
      */
-    searchClient: SearchClient;
+    searchClient: SearchClient | CompositionClient;
     /**
      * The locale used to display numbers. This will be passed
      * to `Number.prototype.toLocaleString()`

package/dist/instantsearch.production.min.d.ts

@@ -1,6 +1,7 @@
 import { AlgoliaSearchHelper } from 'algoliasearch-helper';
 import { Banner } from 'algoliasearch-helper';
 import type { CarouselProps } from 'instantsearch-ui-components';
+import { CompositionClient } from 'algoliasearch-helper/types/algoliasearch.js';
 import EventEmitter from '@algolia/events';
 import { FindAnswersOptions } from 'algoliasearch-helper/types/algoliasearch.js';
 import type { FrequentlyBoughtTogetherProps } from 'instantsearch-ui-components';
@@ -5047,6 +5048,7 @@ declare type InsightsProps<TInsightsClient extends ProvidedInsightsClient = Prov
 declare class InstantSearch<TUiState extends UiState = UiState, TRouteState = TUiState> extends EventEmitter {
     client: InstantSearchOptions['searchClient'];
     indexName: string;
+    compositionID?: string;
     insightsClient: InsightsClient | null;
     onStateChange: InstantSearchOptions<TUiState>['onStateChange'] | null;
     future: NonNullable<InstantSearchOptions<TUiState>['future']>;
@@ -5208,6 +5210,12 @@ declare type InstantSearchOptions<TUiState extends UiState = UiState, TRouteStat
      * The name of the main index. If no indexName is provided, you have to manually add an index widget.
      */
     indexName?: string;
+    /**
+     * The objectID of the composition.
+     * If this is passed, the composition API will be used for search.
+     * Multi-index search is not supported with this option.
+     */
+    compositionID?: string;
     /**
      * The search client to plug to InstantSearch.js
      *
@@ -5235,7 +5243,7 @@ declare type InstantSearchOptions<TUiState extends UiState = UiState, TRouteStat
      * });
      * ```
      */
-    searchClient: SearchClient;
+    searchClient: SearchClient | CompositionClient;
     /**
      * The locale used to display numbers. This will be passed
      * to `Number.prototype.toLocaleString()`