instantsearch.js 4.49.4 → 4.50.1

package/es/types/widget.d.ts

@@ -4,12 +4,12 @@ import type { InstantSearch } from './instantsearch';
 import type { IndexUiState, UiState } from './ui-state';
 import type { IndexRenderState, WidgetRenderState } from './render-state';
 import type { Expand, RequiredKeys } from './utils';
-export declare type ScopedResult = {
+export type ScopedResult = {
     indexId: string;
     results: SearchResults;
     helper: Helper;
 };
-declare type SharedRenderOptions = {
+type SharedRenderOptions = {
     instantSearchInstance: InstantSearch;
     parent: IndexWidget;
     templatesConfig: Record<string, unknown>;
@@ -26,32 +26,32 @@ declare type SharedRenderOptions = {
     error: InstantSearch['error'];
     createURL(state: SearchParameters): string;
 };
-export declare type InitOptions = SharedRenderOptions & {
+export type InitOptions = SharedRenderOptions & {
     uiState: UiState;
     results?: undefined;
 };
-export declare type RenderOptions = SharedRenderOptions & {
+export type RenderOptions = SharedRenderOptions & {
     results: SearchResults;
 };
-export declare type DisposeOptions = {
+export type DisposeOptions = {
     helper: Helper;
     state: SearchParameters;
     parent: IndexWidget;
 };
-export declare type BuiltinTypes = 'ais.analytics' | 'ais.answers' | 'ais.autocomplete' | 'ais.breadcrumb' | 'ais.clearRefinements' | 'ais.configure' | 'ais.configureRelatedItems' | 'ais.currentRefinements' | 'ais.dynamicWidgets' | 'ais.geoSearch' | 'ais.hierarchicalMenu' | 'ais.hits' | 'ais.hitsPerPage' | 'ais.index' | 'ais.infiniteHits' | 'ais.menu' | 'ais.numericMenu' | 'ais.pagination' | 'ais.places' | 'ais.poweredBy' | 'ais.queryRules' | 'ais.range' | 'ais.rangeSlider' | 'ais.rangeInput' | 'ais.ratingMenu' | 'ais.refinementList' | 'ais.searchBox' | 'ais.relevantSort' | 'ais.sortBy' | 'ais.stats' | 'ais.toggleRefinement' | 'ais.voiceSearch';
-export declare type BuiltinWidgetTypes = 'ais.analytics' | 'ais.answers' | 'ais.autocomplete' | 'ais.breadcrumb' | 'ais.clearRefinements' | 'ais.configure' | 'ais.configureRelatedItems' | 'ais.currentRefinements' | 'ais.dynamicWidgets' | 'ais.geoSearch' | 'ais.hierarchicalMenu' | 'ais.hits' | 'ais.hitsPerPage' | 'ais.index' | 'ais.infiniteHits' | 'ais.menu' | 'ais.menuSelect' | 'ais.numericMenu' | 'ais.pagination' | 'ais.places' | 'ais.poweredBy' | 'ais.queryRuleCustomData' | 'ais.queryRuleContext' | 'ais.rangeInput' | 'ais.rangeSlider' | 'ais.ratingMenu' | 'ais.refinementList' | 'ais.searchBox' | 'ais.relevantSort' | 'ais.sortBy' | 'ais.stats' | 'ais.toggleRefinement' | 'ais.voiceSearch';
-export declare type UnknownWidgetParams = NonNullable<object>;
-export declare type WidgetParams = {
+export type BuiltinTypes = 'ais.analytics' | 'ais.answers' | 'ais.autocomplete' | 'ais.breadcrumb' | 'ais.clearRefinements' | 'ais.configure' | 'ais.configureRelatedItems' | 'ais.currentRefinements' | 'ais.dynamicWidgets' | 'ais.geoSearch' | 'ais.hierarchicalMenu' | 'ais.hits' | 'ais.hitsPerPage' | 'ais.index' | 'ais.infiniteHits' | 'ais.menu' | 'ais.numericMenu' | 'ais.pagination' | 'ais.places' | 'ais.poweredBy' | 'ais.queryRules' | 'ais.range' | 'ais.rangeSlider' | 'ais.rangeInput' | 'ais.ratingMenu' | 'ais.refinementList' | 'ais.searchBox' | 'ais.relevantSort' | 'ais.sortBy' | 'ais.stats' | 'ais.toggleRefinement' | 'ais.voiceSearch';
+export type BuiltinWidgetTypes = 'ais.analytics' | 'ais.answers' | 'ais.autocomplete' | 'ais.breadcrumb' | 'ais.clearRefinements' | 'ais.configure' | 'ais.configureRelatedItems' | 'ais.currentRefinements' | 'ais.dynamicWidgets' | 'ais.geoSearch' | 'ais.hierarchicalMenu' | 'ais.hits' | 'ais.hitsPerPage' | 'ais.index' | 'ais.infiniteHits' | 'ais.menu' | 'ais.menuSelect' | 'ais.numericMenu' | 'ais.pagination' | 'ais.places' | 'ais.poweredBy' | 'ais.queryRuleCustomData' | 'ais.queryRuleContext' | 'ais.rangeInput' | 'ais.rangeSlider' | 'ais.ratingMenu' | 'ais.refinementList' | 'ais.searchBox' | 'ais.relevantSort' | 'ais.sortBy' | 'ais.stats' | 'ais.toggleRefinement' | 'ais.voiceSearch';
+export type UnknownWidgetParams = NonNullable<object>;
+export type WidgetParams = {
     widgetParams?: UnknownWidgetParams;
 };
-export declare type WidgetDescription = {
+export type WidgetDescription = {
     $$type: string;
     $$widgetType?: string;
     renderState?: Record<string, unknown>;
     indexRenderState?: Record<string, unknown>;
     indexUiState?: Record<string, unknown>;
 };
-declare type RequiredWidgetLifeCycle<TWidgetDescription extends WidgetDescription> = {
+type RequiredWidgetLifeCycle<TWidgetDescription extends WidgetDescription> = {
     /**
      * Identifier for connectors and widgets.
      */
@@ -70,19 +70,19 @@ declare type RequiredWidgetLifeCycle<TWidgetDescription extends WidgetDescriptio
      */
     dispose?: (options: DisposeOptions) => SearchParameters | void;
 };
-declare type RequiredWidgetType<TWidgetDescription extends WidgetDescription> = {
+type RequiredWidgetType<TWidgetDescription extends WidgetDescription> = {
     /**
      * Identifier for widgets.
      */
     $$widgetType: TWidgetDescription['$$widgetType'];
 };
-declare type WidgetType<TWidgetDescription extends WidgetDescription> = TWidgetDescription extends RequiredKeys<WidgetDescription, '$$widgetType'> ? RequiredWidgetType<TWidgetDescription> : {
+type WidgetType<TWidgetDescription extends WidgetDescription> = TWidgetDescription extends RequiredKeys<WidgetDescription, '$$widgetType'> ? RequiredWidgetType<TWidgetDescription> : {
     /**
      * Identifier for widgets.
      */
     $$widgetType?: string;
 };
-declare type RequiredUiStateLifeCycle<TWidgetDescription extends WidgetDescription> = {
+type RequiredUiStateLifeCycle<TWidgetDescription extends WidgetDescription> = {
     /**
      * This function is required for a widget to be taken in account for routing.
      * It will derive a uiState for this widget based on the existing uiState and
@@ -117,8 +117,8 @@ declare type RequiredUiStateLifeCycle<TWidgetDescription extends WidgetDescripti
         uiState: Expand<Partial<TWidgetDescription['indexUiState'] & IndexUiState>>;
     }) => SearchParameters;
 };
-declare type UiStateLifeCycle<TWidgetDescription extends WidgetDescription> = TWidgetDescription extends RequiredKeys<WidgetDescription, 'indexUiState'> ? RequiredUiStateLifeCycle<TWidgetDescription> : Partial<RequiredUiStateLifeCycle<TWidgetDescription>>;
-declare type RequiredRenderStateLifeCycle<TWidgetDescription extends WidgetDescription & WidgetParams> = {
+type UiStateLifeCycle<TWidgetDescription extends WidgetDescription> = TWidgetDescription extends RequiredKeys<WidgetDescription, 'indexUiState'> ? RequiredUiStateLifeCycle<TWidgetDescription> : Partial<RequiredUiStateLifeCycle<TWidgetDescription>>;
+type RequiredRenderStateLifeCycle<TWidgetDescription extends WidgetDescription & WidgetParams> = {
     /**
      * Returns the render state of the current widget to pass to the render function.
      */
@@ -129,24 +129,24 @@ declare type RequiredRenderStateLifeCycle<TWidgetDescription extends WidgetDescr
      */
     getRenderState: (renderState: Expand<IndexRenderState & Partial<TWidgetDescription['indexRenderState']>>, renderOptions: InitOptions | RenderOptions) => IndexRenderState & TWidgetDescription['indexRenderState'];
 };
-declare type RenderStateLifeCycle<TWidgetDescription extends WidgetDescription & WidgetParams> = TWidgetDescription extends RequiredKeys<WidgetDescription, 'renderState' | 'indexRenderState'> & WidgetParams ? RequiredRenderStateLifeCycle<TWidgetDescription> : Partial<RequiredRenderStateLifeCycle<TWidgetDescription>>;
-export declare type Widget<TWidgetDescription extends WidgetDescription & WidgetParams = {
+type RenderStateLifeCycle<TWidgetDescription extends WidgetDescription & WidgetParams> = TWidgetDescription extends RequiredKeys<WidgetDescription, 'renderState' | 'indexRenderState'> & WidgetParams ? RequiredRenderStateLifeCycle<TWidgetDescription> : Partial<RequiredRenderStateLifeCycle<TWidgetDescription>>;
+export type Widget<TWidgetDescription extends WidgetDescription & WidgetParams = {
     $$type: string;
 }> = Expand<RequiredWidgetLifeCycle<TWidgetDescription> & WidgetType<TWidgetDescription> & UiStateLifeCycle<TWidgetDescription> & RenderStateLifeCycle<TWidgetDescription>>;
-export declare type TransformItemsMetadata = {
+export type TransformItemsMetadata = {
     results?: SearchResults;
 };
 /**
  * Transforms the given items.
  */
-export declare type TransformItems<TItem, TMetadata = TransformItemsMetadata> = (items: TItem[], metadata: TMetadata) => TItem[];
-declare type SortByDirection<TCriterion extends string> = TCriterion | `${TCriterion}:asc` | `${TCriterion}:desc`;
+export type TransformItems<TItem, TMetadata = TransformItemsMetadata> = (items: TItem[], metadata: TMetadata) => TItem[];
+type SortByDirection<TCriterion extends string> = TCriterion | `${TCriterion}:asc` | `${TCriterion}:desc`;
 /**
  * Transforms the given items.
  */
-export declare type SortBy<TItem> = ((a: TItem, b: TItem) => number) | Array<SortByDirection<'count' | 'name' | 'isRefined'>>;
+export type SortBy<TItem> = ((a: TItem, b: TItem) => number) | Array<SortByDirection<'count' | 'name' | 'isRefined'>>;
 /**
  * Creates the URL for the given value.
  */
-export declare type CreateURL<TValue> = (value: TValue) => string;
+export type CreateURL<TValue> = (value: TValue) => string;
 export {};

package/es/widgets/analytics/analytics.d.ts

@@ -1,6 +1,6 @@
 import type { SearchParameters, SearchResults } from 'algoliasearch-helper';
 import type { WidgetFactory, WidgetRenderState } from '../../types';
-export declare type AnalyticsWidgetParamsPushFunction = (
+export type AnalyticsWidgetParamsPushFunction = (
 /**
  * Contains the search parameters, serialized as a query string.
  */
@@ -13,7 +13,7 @@ state: SearchParameters,
  * The last received results.
  */
 results: SearchResults) => void;
-export declare type AnalyticsWidgetParams = {
+export type AnalyticsWidgetParams = {
     /**
      * A function that is called every time the query or refinements changes. You
      * need to add the logic to push the data to your analytics platform.
@@ -48,7 +48,7 @@ export declare type AnalyticsWidgetParams = {
      */
     pushPagination?: boolean;
 };
-export declare type AnalyticsWidgetDescription = {
+export type AnalyticsWidgetDescription = {
     $$type: 'ais.analytics';
     $$widgetType: 'ais.analytics';
     renderState: Record<string, unknown>;
@@ -56,6 +56,6 @@ export declare type AnalyticsWidgetDescription = {
         analytics: WidgetRenderState<Record<string, unknown>, AnalyticsWidgetParams>;
     };
 };
-export declare type AnalyticsWidget = WidgetFactory<AnalyticsWidgetDescription, AnalyticsWidgetParams, AnalyticsWidgetParams>;
+export type AnalyticsWidget = WidgetFactory<AnalyticsWidgetDescription, AnalyticsWidgetParams, AnalyticsWidgetParams>;
 declare const analytics: AnalyticsWidget;
 export default analytics;

package/es/widgets/answers/answers.d.ts

@@ -1,7 +1,7 @@
 
 import type { WidgetFactory, Template, Hit } from '../../types';
 import type { AnswersConnectorParams, AnswersWidgetDescription } from '../../connectors/answers/connectAnswers';
-export declare type AnswersTemplates = Partial<{
+export type AnswersTemplates = Partial<{
     /**
      * Template to use for the header. This template will receive an object containing `hits` and `isLoading`.
      */
@@ -18,7 +18,7 @@ export declare type AnswersTemplates = Partial<{
      */
     item: Template<Hit>;
 }>;
-export declare type AnswersCSSClasses = Partial<{
+export type AnswersCSSClasses = Partial<{
     /**
      * CSS class to add to the root element of the widget.
      */
@@ -44,7 +44,7 @@ export declare type AnswersCSSClasses = Partial<{
      */
     item: string | string[];
 }>;
-export declare type AnswersWidgetParams = {
+export type AnswersWidgetParams = {
     /**
      * CSS Selector or HTMLElement to insert the widget.
      */
@@ -58,7 +58,7 @@ export declare type AnswersWidgetParams = {
      */
     cssClasses?: AnswersCSSClasses;
 };
-export declare type AnswersWidget = WidgetFactory<AnswersWidgetDescription & {
+export type AnswersWidget = WidgetFactory<AnswersWidgetDescription & {
     $$widgetType: 'ais.answers';
 }, AnswersConnectorParams, AnswersWidgetParams>;
 declare const answersWidget: AnswersWidget;

package/es/widgets/breadcrumb/breadcrumb.d.ts

@@ -1,7 +1,7 @@
 
 import type { BreadcrumbWidgetDescription, BreadcrumbConnectorParams } from '../../connectors/breadcrumb/connectBreadcrumb';
 import type { WidgetFactory, Template } from '../../types';
-export declare type BreadcrumbCSSClasses = Partial<{
+export type BreadcrumbCSSClasses = Partial<{
     /**
      * CSS class to add to the root element of the widget.
      */
@@ -31,7 +31,7 @@ export declare type BreadcrumbCSSClasses = Partial<{
      */
     link: string | string[];
 }>;
-export declare type BreadcrumbTemplates = Partial<{
+export type BreadcrumbTemplates = Partial<{
     /**
      * Label of the breadcrumb's first element.
      */
@@ -41,7 +41,7 @@ export declare type BreadcrumbTemplates = Partial<{
      */
     separator: Template;
 }>;
-export declare type BreadcrumbWidgetParams = {
+export type BreadcrumbWidgetParams = {
     /**
      * CSS Selector or HTMLElement to insert the widget.
      */
@@ -55,7 +55,7 @@ export declare type BreadcrumbWidgetParams = {
      */
     cssClasses?: BreadcrumbCSSClasses;
 };
-export declare type BreadcrumbWidget = WidgetFactory<BreadcrumbWidgetDescription & {
+export type BreadcrumbWidget = WidgetFactory<BreadcrumbWidgetDescription & {
     $$widgetType: 'ais.breadcrumb';
 }, BreadcrumbConnectorParams, BreadcrumbWidgetParams>;
 declare const breadcrumb: BreadcrumbWidget;

package/es/widgets/clear-refinements/clear-refinements.d.ts

@@ -1,7 +1,7 @@
 
 import type { ClearRefinementsConnectorParams, ClearRefinementsWidgetDescription } from '../../connectors/clear-refinements/connectClearRefinements';
 import type { WidgetFactory, Template } from '../../types';
-export declare type ClearRefinementsCSSClasses = Partial<{
+export type ClearRefinementsCSSClasses = Partial<{
     /**
      * CSS class to add to the wrapper element.
      */
@@ -15,7 +15,7 @@ export declare type ClearRefinementsCSSClasses = Partial<{
      */
     disabledButton: string | string[];
 }>;
-export declare type ClearRefinementsTemplates = Partial<{
+export type ClearRefinementsTemplates = Partial<{
     /**
      * Template for the content of the button
      */
@@ -23,7 +23,7 @@ export declare type ClearRefinementsTemplates = Partial<{
         hasRefinements: boolean;
     }>;
 }>;
-export declare type ClearRefinementsWidgetParams = {
+export type ClearRefinementsWidgetParams = {
     /**
      * CSS Selector or HTMLElement to insert the widget.
      */
@@ -37,7 +37,7 @@ export declare type ClearRefinementsWidgetParams = {
      */
     cssClasses?: ClearRefinementsCSSClasses;
 };
-export declare type ClearRefinementsWidget = WidgetFactory<ClearRefinementsWidgetDescription & {
+export type ClearRefinementsWidget = WidgetFactory<ClearRefinementsWidgetDescription & {
     $$widgetType: 'ais.clearRefinements';
 }, ClearRefinementsConnectorParams, ClearRefinementsWidgetParams>;
 declare const clearRefinements: ClearRefinementsWidget;

package/es/widgets/configure/configure.d.ts

@@ -4,8 +4,8 @@ import type { Widget } from '../../types';
  * A list of [search parameters](https://www.algolia.com/doc/api-reference/search-api-parameters/)
  * to enable when the widget mounts.
  */
-export declare type ConfigureWidgetParams = ConfigureConnectorParams['searchParameters'];
-export declare type ConfigureWidget = (widgetParams: ConfigureWidgetParams) => Widget<ConfigureWidgetDescription & {
+export type ConfigureWidgetParams = ConfigureConnectorParams['searchParameters'];
+export type ConfigureWidget = (widgetParams: ConfigureWidgetParams) => Widget<ConfigureWidgetDescription & {
     $$widgetType: 'ais.configure';
     widgetParams: ConfigureConnectorParams;
 }>;

package/es/widgets/configure-related-items/configure-related-items.d.ts

@@ -1,9 +1,9 @@
 import type { PlainSearchParameters } from 'algoliasearch-helper';
 import type { ConfigureRelatedItemsConnectorParams, ConfigureRelatedItemsWidgetDescription } from '../../connectors/configure-related-items/connectConfigureRelatedItems';
 import type { WidgetFactory } from '../../types';
-export declare type ConfigureRelatedItemsWidget = WidgetFactory<ConfigureRelatedItemsWidgetDescription & {
+export type ConfigureRelatedItemsWidget = WidgetFactory<ConfigureRelatedItemsWidgetDescription & {
     $$widgetType: 'ais.configureRelatedItems';
 }, ConfigureRelatedItemsConnectorParams, ConfigureRelatedItemsWidgetParams>;
-export declare type ConfigureRelatedItemsWidgetParams = PlainSearchParameters;
+export type ConfigureRelatedItemsWidgetParams = PlainSearchParameters;
 declare const configureRelatedItems: ConfigureRelatedItemsWidget;
 export default configureRelatedItems;

package/es/widgets/current-refinements/current-refinements.d.ts

@@ -1,7 +1,7 @@
 
 import type { CurrentRefinementsConnectorParams, CurrentRefinementsWidgetDescription } from '../../connectors/current-refinements/connectCurrentRefinements';
 import type { WidgetFactory } from '../../types';
-export declare type CurrentRefinementsCSSClasses = Partial<{
+export type CurrentRefinementsCSSClasses = Partial<{
     /**
      * CSS class to add to the root element.
      */
@@ -35,7 +35,7 @@ export declare type CurrentRefinementsCSSClasses = Partial<{
      */
     delete: string | string[];
 }>;
-export declare type CurrentRefinementsWidgetParams = {
+export type CurrentRefinementsWidgetParams = {
     /**
      * The CSS Selector or `HTMLElement` to insert the widget into.
      */
@@ -45,7 +45,7 @@ export declare type CurrentRefinementsWidgetParams = {
      */
     cssClasses?: CurrentRefinementsCSSClasses;
 };
-export declare type CurrentRefinementsWidget = WidgetFactory<CurrentRefinementsWidgetDescription & {
+export type CurrentRefinementsWidget = WidgetFactory<CurrentRefinementsWidgetDescription & {
     $$widgetType: 'ais.currentRefinements';
 }, CurrentRefinementsConnectorParams, CurrentRefinementsWidgetParams>;
 declare const currentRefinements: CurrentRefinementsWidget;

package/es/widgets/dynamic-widgets/dynamic-widgets.d.ts

@@ -1,6 +1,6 @@
 import type { DynamicWidgetsConnectorParams, DynamicWidgetsWidgetDescription } from '../../connectors/dynamic-widgets/connectDynamicWidgets';
 import type { Widget, WidgetFactory } from '../../types';
-export declare type DynamicWidgetsWidgetParams = {
+export type DynamicWidgetsWidgetParams = {
     /**
      * CSS Selector or HTMLElement to insert the widget.
      */
@@ -21,7 +21,7 @@ export declare type DynamicWidgetsWidgetParams = {
         container: HTMLElement;
     }): Widget;
 };
-export declare type DynamicWidgetsWidget = WidgetFactory<DynamicWidgetsWidgetDescription & {
+export type DynamicWidgetsWidget = WidgetFactory<DynamicWidgetsWidgetDescription & {
     $$widgetType: 'ais.dynamicWidgets';
 }, Omit<DynamicWidgetsConnectorParams, 'widgets' | 'fallbackWidget'>, DynamicWidgetsWidgetParams>;
 declare const dynamicWidgets: DynamicWidgetsWidget;

package/es/widgets/geo-search/createHTMLMarker.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="google.maps" />
 /// <reference types="googlemaps" />
 import type { renderTemplate } from '../../lib/templating';
-export declare type HTMLMarkerArguments = {
+export type HTMLMarkerArguments = {
     __id: string;
     position: google.maps.LatLngLiteral;
     map: google.maps.Map;

package/es/widgets/geo-search/geo-search.d.ts

@@ -3,11 +3,11 @@
 import type { GeoSearchConnectorParams, GeoSearchWidgetDescription, GeoHit } from '../../connectors/geo-search/connectGeoSearch';
 import type { HTMLMarkerArguments } from './createHTMLMarker';
 import type { GeoLoc, Template, WidgetFactory } from '../../types';
-export declare type CreateMarker = (args: {
+export type CreateMarker = (args: {
     item: GeoHit;
     map: google.maps.Map;
 }) => google.maps.OverlayView | google.maps.Marker;
-export declare type GeoSearchTemplates = Partial<{
+export type GeoSearchTemplates = Partial<{
     /** Template to use for the marker. */
     HTMLMarker: Template<GeoHit>;
     /** Template for the reset button. */
@@ -17,8 +17,8 @@ export declare type GeoSearchTemplates = Partial<{
     /** Template for the redo button. */
     redo: Template;
 }>;
-export declare type GeoSearchComponentTemplates = Required<GeoSearchTemplates>;
-export declare type GeoSearchCSSClasses = Partial<{
+export type GeoSearchComponentTemplates = Required<GeoSearchTemplates>;
+export type GeoSearchCSSClasses = Partial<{
     /** The root div of the widget. */
     root: string | string[];
     /** The map container of the widget. */
@@ -38,7 +38,7 @@ export declare type GeoSearchCSSClasses = Partial<{
     /** The reset refinement button. */
     reset: string | string[];
 }>;
-export declare type GeoSearchMarker<TOptions> = {
+export type GeoSearchMarker<TOptions> = {
     /**
      * Function used to create the options passed to the Google Maps marker.
      * See the documentation for more information:
@@ -59,7 +59,7 @@ export declare type GeoSearchMarker<TOptions> = {
         }) => void;
     };
 };
-export declare type GeoSearchWidgetParams = {
+export type GeoSearchWidgetParams = {
     /**
      * By default the map will set the zoom accordingly to the markers displayed on it.
      * When we refine it may happen that the results are empty. For those situations we
@@ -122,7 +122,7 @@ export declare type GeoSearchWidgetParams = {
      */
     googleReference: typeof window['google'];
 };
-export declare type GeoSearchWidget = WidgetFactory<GeoSearchWidgetDescription & {
+export type GeoSearchWidget = WidgetFactory<GeoSearchWidgetDescription & {
     $$widgetType: 'ais.geoSearch';
 }, GeoSearchConnectorParams, GeoSearchWidgetParams>;
 /**

package/es/widgets/hierarchical-menu/hierarchical-menu.d.ts

@@ -1,7 +1,7 @@
 
 import type { HierarchicalMenuItem, HierarchicalMenuConnectorParams, HierarchicalMenuWidgetDescription } from '../../connectors/hierarchical-menu/connectHierarchicalMenu';
 import type { TransformItems, Template, WidgetFactory, SortBy, ComponentCSSClasses } from '../../types';
-declare type HierarchicalMenuTemplates = Partial<{
+type HierarchicalMenuTemplates = Partial<{
     /**
      * Item template, provided with `name`, `count`, `isRefined`, `url` data properties.
      */
@@ -20,7 +20,7 @@ declare type HierarchicalMenuTemplates = Partial<{
         isShowingMore: boolean;
     }>;
 }>;
-export declare type HierarchicalMenuCSSClasses = Partial<{
+export type HierarchicalMenuCSSClasses = Partial<{
     /**
      * CSS class to add to the root element.
      */
@@ -74,9 +74,9 @@ export declare type HierarchicalMenuCSSClasses = Partial<{
      */
     disabledShowMore: string | string[];
 }>;
-export declare type HierarchicalMenuComponentCSSClasses = ComponentCSSClasses<HierarchicalMenuCSSClasses>;
-export declare type HierarchicalMenuComponentTemplates = Required<HierarchicalMenuTemplates>;
-export declare type HierarchicalMenuWidgetParams = {
+export type HierarchicalMenuComponentCSSClasses = ComponentCSSClasses<HierarchicalMenuCSSClasses>;
+export type HierarchicalMenuComponentTemplates = Required<HierarchicalMenuTemplates>;
+export type HierarchicalMenuWidgetParams = {
     /**
      * CSS Selector or HTMLElement to insert the widget.
      */
@@ -197,7 +197,7 @@ export declare type HierarchicalMenuWidgetParams = {
  *   })
  * ]);
  */
-export declare type HierarchicalMenuWidget = WidgetFactory<HierarchicalMenuWidgetDescription & {
+export type HierarchicalMenuWidget = WidgetFactory<HierarchicalMenuWidgetDescription & {
     $$widgetType: 'ais.hierarchicalMenu';
 }, HierarchicalMenuConnectorParams, HierarchicalMenuWidgetParams>;
 declare const hierarchicalMenu: HierarchicalMenuWidget;

package/es/widgets/hits/hits.d.ts

@@ -2,7 +2,7 @@
 import type { HitsConnectorParams, HitsWidgetDescription } from '../../connectors/hits/connectHits';
 import type { Template, TemplateWithBindEvent, Hit, WidgetFactory } from '../../types';
 import type { SearchResults } from 'algoliasearch-helper';
-export declare type HitsCSSClasses = Partial<{
+export type HitsCSSClasses = Partial<{
     /**
      * CSS class to add to the wrapping element.
      */
@@ -20,7 +20,7 @@ export declare type HitsCSSClasses = Partial<{
      */
     item: string | string[];
 }>;
-export declare type HitsTemplates = Partial<{
+export type HitsTemplates = Partial<{
     /**
      * Template to use when there are no results.
      *
@@ -36,7 +36,7 @@ export declare type HitsTemplates = Partial<{
         __hitIndex: number;
     }>;
 }>;
-export declare type HitsWidgetParams = {
+export type HitsWidgetParams = {
     /**
      * CSS Selector or HTMLElement to insert the widget.
      */
@@ -50,7 +50,7 @@ export declare type HitsWidgetParams = {
      */
     cssClasses?: HitsCSSClasses;
 };
-export declare type HitsWidget = WidgetFactory<HitsWidgetDescription & {
+export type HitsWidget = WidgetFactory<HitsWidgetDescription & {
     $$widgetType: 'ais.hits';
 }, HitsConnectorParams, HitsWidgetParams>;
 declare const hits: HitsWidget;

package/es/widgets/hits/hits.js

@@ -28,7 +28,8 @@ var renderer = function renderer(_ref) {
       results = _ref2.results,
       instantSearchInstance = _ref2.instantSearchInstance,
       insights = _ref2.insights,
-      bindEvent = _ref2.bindEvent;
+      bindEvent = _ref2.bindEvent,
+      sendEvent = _ref2.sendEvent;
     if (isFirstRendering) {
       renderState.templateProps = prepareTemplateProps({
         defaultTemplates: defaultTemplates,
@@ -43,9 +44,7 @@ var renderer = function renderer(_ref) {
       results: results,
       templateProps: renderState.templateProps,
       insights: insights,
-      sendEvent: function sendEvent(event) {
-        instantSearchInstance.sendEventToInsights(event);
-      },
+      sendEvent: sendEvent,
       bindEvent: bindEvent
     }), containerNode);
   };

package/es/widgets/hits-per-page/hits-per-page.d.ts

@@ -1,7 +1,7 @@
 
 import type { HitsPerPageConnectorParams, HitsPerPageWidgetDescription } from '../../connectors/hits-per-page/connectHitsPerPage';
 import type { WidgetFactory } from '../../types';
-export declare type HitsPerPageCSSClasses = Partial<{
+export type HitsPerPageCSSClasses = Partial<{
     /**
      * CSS classes added to the outer `<div>`.
      */
@@ -15,7 +15,7 @@ export declare type HitsPerPageCSSClasses = Partial<{
      */
     option: string | string[];
 }>;
-export declare type HitsPerPageWidgetParams = {
+export type HitsPerPageWidgetParams = {
     /**
      * CSS Selector or HTMLElement to insert the widget.
      */
@@ -25,7 +25,7 @@ export declare type HitsPerPageWidgetParams = {
      */
     cssClasses?: HitsPerPageCSSClasses;
 };
-export declare type HitsPerPageWidget = WidgetFactory<HitsPerPageWidgetDescription & {
+export type HitsPerPageWidget = WidgetFactory<HitsPerPageWidgetDescription & {
     $$widgetType: 'ais.hitsPerPage';
 }, HitsPerPageConnectorParams, HitsPerPageWidgetParams>;
 declare const hitsPerPage: HitsPerPageWidget;

package/es/widgets/index/index.d.ts

@@ -1,22 +1,22 @@
 import type { AlgoliaSearchHelper as Helper, SearchParameters, SearchResults } from 'algoliasearch-helper';
 import type { InstantSearch, UiState, IndexUiState, Widget, ScopedResult } from '../../types';
-export declare type IndexWidgetParams = {
+export type IndexWidgetParams = {
     indexName: string;
     indexId?: string;
 };
-export declare type IndexInitOptions = {
+export type IndexInitOptions = {
     instantSearchInstance: InstantSearch;
     parent: IndexWidget | null;
     uiState: UiState;
 };
-export declare type IndexRenderOptions = {
+export type IndexRenderOptions = {
     instantSearchInstance: InstantSearch;
 };
-export declare type IndexWidgetDescription = {
+export type IndexWidgetDescription = {
     $$type: 'ais.index';
     $$widgetType: 'ais.index';
 };
-export declare type IndexWidget = Omit<Widget<IndexWidgetDescription & {
+export type IndexWidget = Omit<Widget<IndexWidgetDescription & {
     widgetParams: IndexWidgetParams;
 }>, 'getWidgetUiState' | 'getWidgetState'> & {
     getIndexName(): string;

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/es/widgets/infinite-hits/infinite-hits.d.ts

@@ -2,7 +2,7 @@
 import type { SearchResults } from 'algoliasearch-helper';
 import type { InfiniteHitsConnectorParams, InfiniteHitsCache, InfiniteHitsWidgetDescription } from '../../connectors/infinite-hits/connectInfiniteHits';
 import type { WidgetFactory, Template, TemplateWithBindEvent, Hit } from '../../types';
-export declare type InfiniteHitsCSSClasses = Partial<{
+export type InfiniteHitsCSSClasses = Partial<{
     /**
      * The root element of the widget.
      */
@@ -36,7 +36,7 @@ export declare type InfiniteHitsCSSClasses = Partial<{
      */
     disabledLoadMore: string | string[];
 }>;
-export declare type InfiniteHitsTemplates = Partial<{
+export type InfiniteHitsTemplates = Partial<{
     /**
      * The template to use when there are no results.
      */
@@ -56,7 +56,7 @@ export declare type InfiniteHitsTemplates = Partial<{
         __hitIndex: number;
     }>;
 }>;
-export declare type InfiniteHitsWidgetParams = {
+export type InfiniteHitsWidgetParams = {
     /**
      * The CSS Selector or `HTMLElement` to insert the widget into.
      */
@@ -76,7 +76,7 @@ export declare type InfiniteHitsWidgetParams = {
      */
     cache?: InfiniteHitsCache;
 };
-export declare type InfiniteHitsWidget = WidgetFactory<InfiniteHitsWidgetDescription & {
+export type InfiniteHitsWidget = WidgetFactory<InfiniteHitsWidgetDescription & {
     $$widgetType: 'ais.infiniteHits';
 }, InfiniteHitsConnectorParams, InfiniteHitsWidgetParams>;
 declare const infiniteHits: InfiniteHitsWidget;