instantsearch.js 4.33.2 → 4.37.0

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

@@ -1,10 +1,9 @@
 /// <reference types="google.maps" />
-/// <reference types="node" />
 
 import type algoliasearch from 'algoliasearch/lite';
 import type { AlgoliaSearchHelper } from 'algoliasearch-helper';
 import type * as ClientSearch from '@algolia/client-search';
-import EventEmitter from 'events';
+import EventEmitter from '@algolia/events';
 import type { InsightsClient as InsightsClient_2 } from 'search-insights';
 import type { InsightsMethodMap } from 'search-insights';
 import type * as Places from 'places.js';
@@ -1102,6 +1101,20 @@ declare type DynamicWidgetsConnectorParams = {
     transformItems?(items: string[], metadata: {
         results: SearchResults;
     }): string[];
+    /**
+     * To prevent unneeded extra network requests when widgets mount or unmount,
+     * we request all facet values.
+     *
+     * @default ['*']
+     */
+    facets?: ['*'] | never[];
+    /**
+     * If you have more than 20 facet values pinned, you need to increase the
+     * maxValuesPerFacet to at least that value.
+     *
+     * @default 20
+     */
+    maxValuesPerFacet?: number;
 };
 
 declare type DynamicWidgetsRenderState = {
@@ -2194,6 +2207,13 @@ declare type InfiniteHitsWidgetParams = {
     cache?: InfiniteHitsCache;
 };
 
+declare type InitialResult = {
+    state: PlainSearchParameters;
+    results: SearchResults['_rawResults'];
+};
+
+declare type InitialResults = Record<string, InitialResult>;
+
 declare type InitOptions = SharedRenderOptions & {
     uiState: UiState;
     results?: undefined;
@@ -2258,6 +2278,7 @@ declare class InstantSearch<TUiState extends UiState = UiState, TRouteState = TU
     _searchStalledTimer: any;
     _isSearchStalled: boolean;
     _initialUiState: UiState;
+    _initialResults: InitialResults | null;
     _createURL: CreateURL<UiState>;
     _searchFunction?: InstantSearchOptions['searchFunction'];
     _mainHelperSearch?: AlgoliaSearchHelper['search'];

package/dist/instantsearch.production.d.ts

@@ -1,10 +1,9 @@
 /// <reference types="google.maps" />
-/// <reference types="node" />
 
 import type algoliasearch from 'algoliasearch/lite';
 import type { AlgoliaSearchHelper } from 'algoliasearch-helper';
 import type * as ClientSearch from '@algolia/client-search';
-import EventEmitter from 'events';
+import EventEmitter from '@algolia/events';
 import type { InsightsClient as InsightsClient_2 } from 'search-insights';
 import type { InsightsMethodMap } from 'search-insights';
 import type * as Places from 'places.js';
@@ -1102,6 +1101,20 @@ declare type DynamicWidgetsConnectorParams = {
     transformItems?(items: string[], metadata: {
         results: SearchResults;
     }): string[];
+    /**
+     * To prevent unneeded extra network requests when widgets mount or unmount,
+     * we request all facet values.
+     *
+     * @default ['*']
+     */
+    facets?: ['*'] | never[];
+    /**
+     * If you have more than 20 facet values pinned, you need to increase the
+     * maxValuesPerFacet to at least that value.
+     *
+     * @default 20
+     */
+    maxValuesPerFacet?: number;
 };
 
 declare type DynamicWidgetsRenderState = {
@@ -2194,6 +2207,13 @@ declare type InfiniteHitsWidgetParams = {
     cache?: InfiniteHitsCache;
 };
 
+declare type InitialResult = {
+    state: PlainSearchParameters;
+    results: SearchResults['_rawResults'];
+};
+
+declare type InitialResults = Record<string, InitialResult>;
+
 declare type InitOptions = SharedRenderOptions & {
     uiState: UiState;
     results?: undefined;
@@ -2258,6 +2278,7 @@ declare class InstantSearch<TUiState extends UiState = UiState, TRouteState = TU
     _searchStalledTimer: any;
     _isSearchStalled: boolean;
     _initialUiState: UiState;
+    _initialResults: InitialResults | null;
     _createURL: CreateURL<UiState>;
     _searchFunction?: InstantSearchOptions['searchFunction'];
     _mainHelperSearch?: AlgoliaSearchHelper['search'];

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

@@ -1,10 +1,9 @@
 /// <reference types="google.maps" />
-/// <reference types="node" />
 
 import type algoliasearch from 'algoliasearch/lite';
 import type { AlgoliaSearchHelper } from 'algoliasearch-helper';
 import type * as ClientSearch from '@algolia/client-search';
-import EventEmitter from 'events';
+import EventEmitter from '@algolia/events';
 import type { InsightsClient as InsightsClient_2 } from 'search-insights';
 import type { InsightsMethodMap } from 'search-insights';
 import type * as Places from 'places.js';
@@ -1102,6 +1101,20 @@ declare type DynamicWidgetsConnectorParams = {
     transformItems?(items: string[], metadata: {
         results: SearchResults;
     }): string[];
+    /**
+     * To prevent unneeded extra network requests when widgets mount or unmount,
+     * we request all facet values.
+     *
+     * @default ['*']
+     */
+    facets?: ['*'] | never[];
+    /**
+     * If you have more than 20 facet values pinned, you need to increase the
+     * maxValuesPerFacet to at least that value.
+     *
+     * @default 20
+     */
+    maxValuesPerFacet?: number;
 };
 
 declare type DynamicWidgetsRenderState = {
@@ -2194,6 +2207,13 @@ declare type InfiniteHitsWidgetParams = {
     cache?: InfiniteHitsCache;
 };
 
+declare type InitialResult = {
+    state: PlainSearchParameters;
+    results: SearchResults['_rawResults'];
+};
+
+declare type InitialResults = Record<string, InitialResult>;
+
 declare type InitOptions = SharedRenderOptions & {
     uiState: UiState;
     results?: undefined;
@@ -2258,6 +2278,7 @@ declare class InstantSearch<TUiState extends UiState = UiState, TRouteState = TU
     _searchStalledTimer: any;
     _isSearchStalled: boolean;
     _initialUiState: UiState;
+    _initialResults: InitialResults | null;
     _createURL: CreateURL<UiState>;
     _searchFunction?: InstantSearchOptions['searchFunction'];
     _mainHelperSearch?: AlgoliaSearchHelper['search'];