instantsearch.js 4.66.1 → 4.68.0

package/dist/instantsearch.production.d.ts

@@ -15,6 +15,7 @@ import type { InsightsMethodMap as InsightsMethodMap_2 } from 'search-insights';
 import type * as Places from 'places.js';
 import type { PlainSearchParameters } from 'algoliasearch-helper';
 import { default as qs_2 } from 'qs';
+import type { RecommendParameters } from 'algoliasearch-helper';
 import { SearchClient } from 'algoliasearch-helper/types/algoliasearch.js';
 import { SearchOptions } from 'algoliasearch-helper/types/algoliasearch.js';
 import type { SearchParameters } from 'algoliasearch-helper';
@@ -242,7 +243,7 @@ declare type AtLeastOne<TTarget, TMapped = {
     [Key in keyof TTarget]: Pick<TTarget, Key>;
 }> = Partial<TTarget> & TMapped[keyof TMapped];
 
-declare type AugmentedWidget<TWidgetFactory extends AnyWidgetFactory, TOverriddenKeys extends keyof Widget = 'init' | 'render' | 'dispose'> = Omit<ReturnType<TWidgetFactory>, TOverriddenKeys> & Pick<Required<Widget>, TOverriddenKeys>;
+declare type AugmentedWidget<TWidgetFactory extends AnyWidgetFactory, TOverriddenKeys extends keyof Widget = 'init' | 'render' | 'dispose'> = Omit<ReturnType<TWidgetFactory>, TOverriddenKeys | 'dependsOn' | 'getWidgetParameters'> & Pick<Required<Widget>, TOverriddenKeys>;
 
 declare type AutocompleteConnector = Connector<AutocompleteWidgetDescription, AutocompleteConnectorParams>;
 
@@ -302,6 +303,8 @@ declare type AutocompleteWidgetDescription = {
     };
 };
 
+declare type Banner = NonNullable<NonNullable<Required<SearchResults<Hit>['renderingContent']>>['widgets']['banners']>[number];
+
 declare type BaseHit = Record<string, unknown>;
 
 declare type BindEventForHits = BuiltInBindEventForHits & CustomBindEventForHits;
@@ -1993,6 +1996,10 @@ declare type HitsRenderState<THit extends BaseHit = BaseHit> = {
      * The response from the Algolia API.
      */
     results?: SearchResults<Hit<THit>>;
+    /**
+     * The banner to display above the hits.
+     */
+    banner?: Banner;
     /**
      * Sends an event to the Insights middleware.
      */
@@ -2019,6 +2026,13 @@ declare type HitsTemplates = Partial<{
         /** @deprecated the index in the hits array, use __position instead, which is the absolute position */
         __hitIndex: number;
     }>;
+    /**
+     * Template to use for the banner.
+     */
+    banner: Template<{
+        banner: Required<HitsRenderState['banner']>;
+        className: string;
+    }>;
 }>;
 
 declare type HitsWidget = WidgetFactory<HitsWidgetDescription & {
@@ -4007,6 +4021,13 @@ declare type Read<THit extends BaseHit> = ({ state, }: {
     state: PlainSearchParameters;
 }) => InfiniteHitsCachedHits<THit> | null;
 
+declare type RecommendWidgetLifeCycle<TWidgetDescription extends WidgetDescription> = {
+    dependsOn?: 'recommend';
+    getWidgetParameters: (state: RecommendParameters, widgetParametersOptions: {
+        uiState: Expand<Partial<TWidgetDescription['indexUiState'] & IndexUiState>>;
+    }) => RecommendParameters;
+};
+
 declare type ReconfigurableOptions = Places.ReconfigurableOptions;
 
 /**
@@ -4517,7 +4538,7 @@ declare type RequiredUiStateLifeCycle<TWidgetDescription extends WidgetDescripti
     getWidgetSearchParameters: (state: SearchParameters, widgetSearchParametersOptions: {
         uiState: Expand<Partial<TWidgetDescription['indexUiState'] & IndexUiState>>;
     }) => SearchParameters;
-};
+} & (SearchWidgetLifeCycle<TWidgetDescription> | RecommendWidgetLifeCycle<TWidgetDescription>);
 
 declare type RequiredWidgetLifeCycle<TWidgetDescription extends WidgetDescription> = {
     /**
@@ -4528,6 +4549,10 @@ declare type RequiredWidgetLifeCycle<TWidgetDescription extends WidgetDescriptio
      * Called once before the first search.
      */
     init?: (options: InitOptions) => void;
+    /**
+     * Whether `render` should be called
+     */
+    shouldRender?: (options: ShouldRenderOptions) => boolean;
     /**
      * Called after each search response has been received.
      */
@@ -4843,6 +4868,13 @@ declare type SearchBoxWidgetParams = {
     queryHook?: (query: string, hook: (value: string) => void) => void;
 };
 
+declare type SearchWidgetLifeCycle<TWidgetDescription extends WidgetDescription> = {
+    dependsOn?: 'search';
+    getWidgetParameters?: (state: SearchParameters, widgetParametersOptions: {
+        uiState: Expand<Partial<TWidgetDescription['indexUiState'] & IndexUiState>>;
+    }) => SearchParameters;
+};
+
 declare type SendEvent = (...args: [InsightsEvent] | [string, string, string?]) => void;
 
 declare type SendEventForFacet = BuiltInSendEventForFacet & CustomSendEventForFacet;
@@ -4869,6 +4901,10 @@ declare type SharedRenderOptions = {
     createURL: (nextState: SearchParameters | ((state: IndexUiState) => IndexUiState)) => string;
 };
 
+declare type ShouldRenderOptions = {
+    instantSearchInstance: InstantSearch;
+};
+
 declare function simpleStateMapping<TUiState extends UiState = UiState>(): StateMapping<TUiState, TUiState>;
 
 declare function singleIndexStateMapping<TUiState extends UiState = UiState>(indexName: keyof TUiState): StateMapping<TUiState, TUiState[typeof indexName]>;

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

@@ -15,6 +15,7 @@ import type { InsightsMethodMap as InsightsMethodMap_2 } from 'search-insights';
 import type * as Places from 'places.js';
 import type { PlainSearchParameters } from 'algoliasearch-helper';
 import { default as qs_2 } from 'qs';
+import type { RecommendParameters } from 'algoliasearch-helper';
 import { SearchClient } from 'algoliasearch-helper/types/algoliasearch.js';
 import { SearchOptions } from 'algoliasearch-helper/types/algoliasearch.js';
 import type { SearchParameters } from 'algoliasearch-helper';
@@ -242,7 +243,7 @@ declare type AtLeastOne<TTarget, TMapped = {
     [Key in keyof TTarget]: Pick<TTarget, Key>;
 }> = Partial<TTarget> & TMapped[keyof TMapped];
 
-declare type AugmentedWidget<TWidgetFactory extends AnyWidgetFactory, TOverriddenKeys extends keyof Widget = 'init' | 'render' | 'dispose'> = Omit<ReturnType<TWidgetFactory>, TOverriddenKeys> & Pick<Required<Widget>, TOverriddenKeys>;
+declare type AugmentedWidget<TWidgetFactory extends AnyWidgetFactory, TOverriddenKeys extends keyof Widget = 'init' | 'render' | 'dispose'> = Omit<ReturnType<TWidgetFactory>, TOverriddenKeys | 'dependsOn' | 'getWidgetParameters'> & Pick<Required<Widget>, TOverriddenKeys>;
 
 declare type AutocompleteConnector = Connector<AutocompleteWidgetDescription, AutocompleteConnectorParams>;
 
@@ -302,6 +303,8 @@ declare type AutocompleteWidgetDescription = {
     };
 };
 
+declare type Banner = NonNullable<NonNullable<Required<SearchResults<Hit>['renderingContent']>>['widgets']['banners']>[number];
+
 declare type BaseHit = Record<string, unknown>;
 
 declare type BindEventForHits = BuiltInBindEventForHits & CustomBindEventForHits;
@@ -1993,6 +1996,10 @@ declare type HitsRenderState<THit extends BaseHit = BaseHit> = {
      * The response from the Algolia API.
      */
     results?: SearchResults<Hit<THit>>;
+    /**
+     * The banner to display above the hits.
+     */
+    banner?: Banner;
     /**
      * Sends an event to the Insights middleware.
      */
@@ -2019,6 +2026,13 @@ declare type HitsTemplates = Partial<{
         /** @deprecated the index in the hits array, use __position instead, which is the absolute position */
         __hitIndex: number;
     }>;
+    /**
+     * Template to use for the banner.
+     */
+    banner: Template<{
+        banner: Required<HitsRenderState['banner']>;
+        className: string;
+    }>;
 }>;
 
 declare type HitsWidget = WidgetFactory<HitsWidgetDescription & {
@@ -4007,6 +4021,13 @@ declare type Read<THit extends BaseHit> = ({ state, }: {
     state: PlainSearchParameters;
 }) => InfiniteHitsCachedHits<THit> | null;
 
+declare type RecommendWidgetLifeCycle<TWidgetDescription extends WidgetDescription> = {
+    dependsOn?: 'recommend';
+    getWidgetParameters: (state: RecommendParameters, widgetParametersOptions: {
+        uiState: Expand<Partial<TWidgetDescription['indexUiState'] & IndexUiState>>;
+    }) => RecommendParameters;
+};
+
 declare type ReconfigurableOptions = Places.ReconfigurableOptions;
 
 /**
@@ -4517,7 +4538,7 @@ declare type RequiredUiStateLifeCycle<TWidgetDescription extends WidgetDescripti
     getWidgetSearchParameters: (state: SearchParameters, widgetSearchParametersOptions: {
         uiState: Expand<Partial<TWidgetDescription['indexUiState'] & IndexUiState>>;
     }) => SearchParameters;
-};
+} & (SearchWidgetLifeCycle<TWidgetDescription> | RecommendWidgetLifeCycle<TWidgetDescription>);
 
 declare type RequiredWidgetLifeCycle<TWidgetDescription extends WidgetDescription> = {
     /**
@@ -4528,6 +4549,10 @@ declare type RequiredWidgetLifeCycle<TWidgetDescription extends WidgetDescriptio
      * Called once before the first search.
      */
     init?: (options: InitOptions) => void;
+    /**
+     * Whether `render` should be called
+     */
+    shouldRender?: (options: ShouldRenderOptions) => boolean;
     /**
      * Called after each search response has been received.
      */
@@ -4843,6 +4868,13 @@ declare type SearchBoxWidgetParams = {
     queryHook?: (query: string, hook: (value: string) => void) => void;
 };
 
+declare type SearchWidgetLifeCycle<TWidgetDescription extends WidgetDescription> = {
+    dependsOn?: 'search';
+    getWidgetParameters?: (state: SearchParameters, widgetParametersOptions: {
+        uiState: Expand<Partial<TWidgetDescription['indexUiState'] & IndexUiState>>;
+    }) => SearchParameters;
+};
+
 declare type SendEvent = (...args: [InsightsEvent] | [string, string, string?]) => void;
 
 declare type SendEventForFacet = BuiltInSendEventForFacet & CustomSendEventForFacet;
@@ -4869,6 +4901,10 @@ declare type SharedRenderOptions = {
     createURL: (nextState: SearchParameters | ((state: IndexUiState) => IndexUiState)) => string;
 };
 
+declare type ShouldRenderOptions = {
+    instantSearchInstance: InstantSearch;
+};
+
 declare function simpleStateMapping<TUiState extends UiState = UiState>(): StateMapping<TUiState, TUiState>;
 
 declare function singleIndexStateMapping<TUiState extends UiState = UiState>(indexName: keyof TUiState): StateMapping<TUiState, TUiState[typeof indexName]>;