instantsearch.js 4.31.0 → 4.33.1

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

@@ -5,6 +5,8 @@ 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 type { InsightsClient as InsightsClient_2 } from 'search-insights';
+import type { InsightsMethodMap } from 'search-insights';
 import type * as Places from 'places.js';
 import type { PlainSearchParameters } from 'algoliasearch-helper';
 import { default as qs_2 } from 'qs';
@@ -453,13 +455,23 @@ declare class BrowserHistory<TRouteState> implements Router<TRouteState> {
      * It should be symmetrical to `createURL`.
      */
     private readonly parseURL;
+    /**
+     * Returns the location to store in the history.
+     * @default () => window.location
+     */
+    private readonly getLocation;
     private writeTimer?;
     private _onPopState;
+    /**
+     * Indicates if history.pushState should be executed.
+     * It needs to avoid pushing state to history in case of back/forward in browser
+     */
+    private shouldPushState;
     /**
      * Initializes a new storage provider that syncs the search state to the URL
      * using web APIs (`window.location.pushState` and `onpopstate` event).
      */
-    constructor({ windowTitle, writeDelay, createURL, parseURL, }: BrowserHistoryArgs<TRouteState>);
+    constructor({ windowTitle, writeDelay, createURL, parseURL, getLocation, }: BrowserHistoryArgs<TRouteState>);
     /**
      * Reads the URL and returns a syncable UI search state.
      */
@@ -492,6 +504,7 @@ declare type BrowserHistoryArgs<TRouteState> = {
     writeDelay: number;
     createURL: CreateURL_2<TRouteState>;
     parseURL: ParseURL<TRouteState>;
+    getLocation(): Location;
 };
 
 declare type BuiltInBindEventForHits = (eventType: string, hits: Hit | Hits, eventName?: string) => string;
@@ -734,7 +747,7 @@ declare const connectNumericMenu: NumericMenuConnector;
  * The connector handles the business logic and exposes
  * a simplified API to the rendering function.
  */
-declare type Connector<TWidgetDescription extends WidgetDescription, TConnectorParams> = <TWidgetParams>(
+declare type Connector<TWidgetDescription extends WidgetDescription, TConnectorParams extends UnknownWidgetParams> = <TWidgetParams extends UnknownWidgetParams>(
 /**
  * The render function.
  */
@@ -1721,7 +1734,7 @@ declare type HighlightOptions = {
     }>;
 };
 
-declare function historyRouter<TRouteState = UiState>({ createURL, parseURL, writeDelay, windowTitle, }?: Partial<BrowserHistoryArgs<TRouteState>>): BrowserHistory<TRouteState>;
+declare function historyRouter<TRouteState = UiState>({ createURL, parseURL, writeDelay, windowTitle, getLocation, }?: Partial<BrowserHistoryArgs<TRouteState>>): BrowserHistory<TRouteState>;
 
 declare type Hit = {
     __position: number;
@@ -2191,13 +2204,11 @@ declare type InitOptions = SharedRenderOptions & {
  */
 declare function insights(method: InsightsClientMethod, payload: Partial<InsightsClientPayload>): string;
 
-declare type InsightsAddAlgoliaAgent = (method: 'addAlgoliaAgent', algoliaAgent: string) => void;
-
-declare type InsightsClient = InsightsAddAlgoliaAgent & InsightsSendEvent & InsightsOnUserTokenChange & InsightsInit & InsightsSetUserToken & InsightsGetUserToken & {
-    queue?: Array<[string, any]>;
+declare type InsightsClient = InsightsClient_2 & {
+    queue?: QueueItem[];
 };
 
-declare type InsightsClientMethod = 'viewedObjectIDs' | 'clickedFilters' | 'clickedObjectIDsAfterSearch' | 'convertedObjectIDsAfterSearch';
+declare type InsightsClientMethod = keyof InsightsMethodMap;
 
 declare type InsightsClientPayload = {
     eventName: string;
@@ -2216,17 +2227,6 @@ declare type InsightsEvent = {
     attribute?: string;
 };
 
-declare type InsightsGetUserToken = (method: 'getUserToken', options?: any, callback?: (error: any, userToken: string) => void) => void;
-
-declare type InsightsInit = (method: 'init', options: {
-    appId: string;
-    apiKey: string;
-}) => void;
-
-declare type InsightsOnUserTokenChange = (method: 'onUserTokenChange', callback?: (userToken: string) => void, options?: {
-    immediate?: boolean;
-}) => void;
-
 declare type InsightsProps = {
     insightsClient: null | InsightsClient;
     insightsInitParams?: {
@@ -2238,10 +2238,6 @@ declare type InsightsProps = {
     onEvent?: (event: InsightsEvent, insightsClient: null | InsightsClient) => void;
 };
 
-declare type InsightsSendEvent = (method: InsightsClientMethod, payload: InsightsClientPayload) => void;
-
-declare type InsightsSetUserToken = (method: 'setUserToken', userToken: string) => void;
-
 /**
  * The actual implementation of the InstantSearch. This is
  * created using the `instantsearch` factory function.
@@ -3343,6 +3339,15 @@ declare type QueryRulesWidgetDescription = {
     };
 };
 
+declare type QueueItem = QueueItemMap[keyof QueueItemMap];
+
+declare type QueueItemMap = {
+    [MethodName in keyof InsightsMethodMap]: [
+    methodName: MethodName,
+    ...args: InsightsMethodMap[MethodName]
+    ];
+};
+
 declare type Range_2 = {
     min: RangeMin;
     max: RangeMax;
@@ -5005,6 +5010,8 @@ declare type UiState = {
 
 declare type UiStateLifeCycle<TWidgetDescription extends WidgetDescription> = TWidgetDescription extends RequiredKeys<WidgetDescription, 'indexUiState'> ? RequiredUiStateLifeCycle<TWidgetDescription> : Partial<RequiredUiStateLifeCycle<TWidgetDescription>>;
 
+declare type UnknownWidgetParams = NonNullable<object>;
+
 /**
  * The called function when unmounting a widget.
  */
@@ -5102,7 +5109,6 @@ declare type VoiceSearchWidgetParams = {
 
 declare type Widget<TWidgetDescription extends WidgetDescription & WidgetParams = {
     $$type: string;
-    widgetParams: unknown;
 }> = Expand<RequiredWidgetLifeCycle<TWidgetDescription> & WidgetType<TWidgetDescription> & UiStateLifeCycle<TWidgetDescription> & RenderStateLifeCycle<TWidgetDescription>>;
 
 declare type WidgetDescription = {
@@ -5116,7 +5122,7 @@ declare type WidgetDescription = {
 /**
  * The function that creates a new widget.
  */
-declare type WidgetFactory<TWidgetDescription extends WidgetDescription, TConnectorParams, TWidgetParams> = (
+declare type WidgetFactory<TWidgetDescription extends WidgetDescription, TConnectorParams extends UnknownWidgetParams, TWidgetParams extends UnknownWidgetParams> = (
 /**
  * The params of the widget.
  */
@@ -5125,7 +5131,7 @@ widgetParams: TWidgetParams & TConnectorParams) => Widget<TWidgetDescription & {
 }>;
 
 declare type WidgetParams = {
-    widgetParams: NonNullable<unknown>;
+    widgetParams?: UnknownWidgetParams;
 };
 
 declare type WidgetRenderState<TWidgetRenderState, TWidgetParams> = TWidgetRenderState & {

package/dist/instantsearch.production.d.ts

@@ -5,6 +5,8 @@ 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 type { InsightsClient as InsightsClient_2 } from 'search-insights';
+import type { InsightsMethodMap } from 'search-insights';
 import type * as Places from 'places.js';
 import type { PlainSearchParameters } from 'algoliasearch-helper';
 import { default as qs_2 } from 'qs';
@@ -453,13 +455,23 @@ declare class BrowserHistory<TRouteState> implements Router<TRouteState> {
      * It should be symmetrical to `createURL`.
      */
     private readonly parseURL;
+    /**
+     * Returns the location to store in the history.
+     * @default () => window.location
+     */
+    private readonly getLocation;
     private writeTimer?;
     private _onPopState;
+    /**
+     * Indicates if history.pushState should be executed.
+     * It needs to avoid pushing state to history in case of back/forward in browser
+     */
+    private shouldPushState;
     /**
      * Initializes a new storage provider that syncs the search state to the URL
      * using web APIs (`window.location.pushState` and `onpopstate` event).
      */
-    constructor({ windowTitle, writeDelay, createURL, parseURL, }: BrowserHistoryArgs<TRouteState>);
+    constructor({ windowTitle, writeDelay, createURL, parseURL, getLocation, }: BrowserHistoryArgs<TRouteState>);
     /**
      * Reads the URL and returns a syncable UI search state.
      */
@@ -492,6 +504,7 @@ declare type BrowserHistoryArgs<TRouteState> = {
     writeDelay: number;
     createURL: CreateURL_2<TRouteState>;
     parseURL: ParseURL<TRouteState>;
+    getLocation(): Location;
 };
 
 declare type BuiltInBindEventForHits = (eventType: string, hits: Hit | Hits, eventName?: string) => string;
@@ -734,7 +747,7 @@ declare const connectNumericMenu: NumericMenuConnector;
  * The connector handles the business logic and exposes
  * a simplified API to the rendering function.
  */
-declare type Connector<TWidgetDescription extends WidgetDescription, TConnectorParams> = <TWidgetParams>(
+declare type Connector<TWidgetDescription extends WidgetDescription, TConnectorParams extends UnknownWidgetParams> = <TWidgetParams extends UnknownWidgetParams>(
 /**
  * The render function.
  */
@@ -1721,7 +1734,7 @@ declare type HighlightOptions = {
     }>;
 };
 
-declare function historyRouter<TRouteState = UiState>({ createURL, parseURL, writeDelay, windowTitle, }?: Partial<BrowserHistoryArgs<TRouteState>>): BrowserHistory<TRouteState>;
+declare function historyRouter<TRouteState = UiState>({ createURL, parseURL, writeDelay, windowTitle, getLocation, }?: Partial<BrowserHistoryArgs<TRouteState>>): BrowserHistory<TRouteState>;
 
 declare type Hit = {
     __position: number;
@@ -2191,13 +2204,11 @@ declare type InitOptions = SharedRenderOptions & {
  */
 declare function insights(method: InsightsClientMethod, payload: Partial<InsightsClientPayload>): string;
 
-declare type InsightsAddAlgoliaAgent = (method: 'addAlgoliaAgent', algoliaAgent: string) => void;
-
-declare type InsightsClient = InsightsAddAlgoliaAgent & InsightsSendEvent & InsightsOnUserTokenChange & InsightsInit & InsightsSetUserToken & InsightsGetUserToken & {
-    queue?: Array<[string, any]>;
+declare type InsightsClient = InsightsClient_2 & {
+    queue?: QueueItem[];
 };
 
-declare type InsightsClientMethod = 'viewedObjectIDs' | 'clickedFilters' | 'clickedObjectIDsAfterSearch' | 'convertedObjectIDsAfterSearch';
+declare type InsightsClientMethod = keyof InsightsMethodMap;
 
 declare type InsightsClientPayload = {
     eventName: string;
@@ -2216,17 +2227,6 @@ declare type InsightsEvent = {
     attribute?: string;
 };
 
-declare type InsightsGetUserToken = (method: 'getUserToken', options?: any, callback?: (error: any, userToken: string) => void) => void;
-
-declare type InsightsInit = (method: 'init', options: {
-    appId: string;
-    apiKey: string;
-}) => void;
-
-declare type InsightsOnUserTokenChange = (method: 'onUserTokenChange', callback?: (userToken: string) => void, options?: {
-    immediate?: boolean;
-}) => void;
-
 declare type InsightsProps = {
     insightsClient: null | InsightsClient;
     insightsInitParams?: {
@@ -2238,10 +2238,6 @@ declare type InsightsProps = {
     onEvent?: (event: InsightsEvent, insightsClient: null | InsightsClient) => void;
 };
 
-declare type InsightsSendEvent = (method: InsightsClientMethod, payload: InsightsClientPayload) => void;
-
-declare type InsightsSetUserToken = (method: 'setUserToken', userToken: string) => void;
-
 /**
  * The actual implementation of the InstantSearch. This is
  * created using the `instantsearch` factory function.
@@ -3343,6 +3339,15 @@ declare type QueryRulesWidgetDescription = {
     };
 };
 
+declare type QueueItem = QueueItemMap[keyof QueueItemMap];
+
+declare type QueueItemMap = {
+    [MethodName in keyof InsightsMethodMap]: [
+    methodName: MethodName,
+    ...args: InsightsMethodMap[MethodName]
+    ];
+};
+
 declare type Range_2 = {
     min: RangeMin;
     max: RangeMax;
@@ -5005,6 +5010,8 @@ declare type UiState = {
 
 declare type UiStateLifeCycle<TWidgetDescription extends WidgetDescription> = TWidgetDescription extends RequiredKeys<WidgetDescription, 'indexUiState'> ? RequiredUiStateLifeCycle<TWidgetDescription> : Partial<RequiredUiStateLifeCycle<TWidgetDescription>>;
 
+declare type UnknownWidgetParams = NonNullable<object>;
+
 /**
  * The called function when unmounting a widget.
  */
@@ -5102,7 +5109,6 @@ declare type VoiceSearchWidgetParams = {
 
 declare type Widget<TWidgetDescription extends WidgetDescription & WidgetParams = {
     $$type: string;
-    widgetParams: unknown;
 }> = Expand<RequiredWidgetLifeCycle<TWidgetDescription> & WidgetType<TWidgetDescription> & UiStateLifeCycle<TWidgetDescription> & RenderStateLifeCycle<TWidgetDescription>>;
 
 declare type WidgetDescription = {
@@ -5116,7 +5122,7 @@ declare type WidgetDescription = {
 /**
  * The function that creates a new widget.
  */
-declare type WidgetFactory<TWidgetDescription extends WidgetDescription, TConnectorParams, TWidgetParams> = (
+declare type WidgetFactory<TWidgetDescription extends WidgetDescription, TConnectorParams extends UnknownWidgetParams, TWidgetParams extends UnknownWidgetParams> = (
 /**
  * The params of the widget.
  */
@@ -5125,7 +5131,7 @@ widgetParams: TWidgetParams & TConnectorParams) => Widget<TWidgetDescription & {
 }>;
 
 declare type WidgetParams = {
-    widgetParams: NonNullable<unknown>;
+    widgetParams?: UnknownWidgetParams;
 };
 
 declare type WidgetRenderState<TWidgetRenderState, TWidgetParams> = TWidgetRenderState & {

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

@@ -5,6 +5,8 @@ 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 type { InsightsClient as InsightsClient_2 } from 'search-insights';
+import type { InsightsMethodMap } from 'search-insights';
 import type * as Places from 'places.js';
 import type { PlainSearchParameters } from 'algoliasearch-helper';
 import { default as qs_2 } from 'qs';
@@ -453,13 +455,23 @@ declare class BrowserHistory<TRouteState> implements Router<TRouteState> {
      * It should be symmetrical to `createURL`.
      */
     private readonly parseURL;
+    /**
+     * Returns the location to store in the history.
+     * @default () => window.location
+     */
+    private readonly getLocation;
     private writeTimer?;
     private _onPopState;
+    /**
+     * Indicates if history.pushState should be executed.
+     * It needs to avoid pushing state to history in case of back/forward in browser
+     */
+    private shouldPushState;
     /**
      * Initializes a new storage provider that syncs the search state to the URL
      * using web APIs (`window.location.pushState` and `onpopstate` event).
      */
-    constructor({ windowTitle, writeDelay, createURL, parseURL, }: BrowserHistoryArgs<TRouteState>);
+    constructor({ windowTitle, writeDelay, createURL, parseURL, getLocation, }: BrowserHistoryArgs<TRouteState>);
     /**
      * Reads the URL and returns a syncable UI search state.
      */
@@ -492,6 +504,7 @@ declare type BrowserHistoryArgs<TRouteState> = {
     writeDelay: number;
     createURL: CreateURL_2<TRouteState>;
     parseURL: ParseURL<TRouteState>;
+    getLocation(): Location;
 };
 
 declare type BuiltInBindEventForHits = (eventType: string, hits: Hit | Hits, eventName?: string) => string;
@@ -734,7 +747,7 @@ declare const connectNumericMenu: NumericMenuConnector;
  * The connector handles the business logic and exposes
  * a simplified API to the rendering function.
  */
-declare type Connector<TWidgetDescription extends WidgetDescription, TConnectorParams> = <TWidgetParams>(
+declare type Connector<TWidgetDescription extends WidgetDescription, TConnectorParams extends UnknownWidgetParams> = <TWidgetParams extends UnknownWidgetParams>(
 /**
  * The render function.
  */
@@ -1721,7 +1734,7 @@ declare type HighlightOptions = {
     }>;
 };
 
-declare function historyRouter<TRouteState = UiState>({ createURL, parseURL, writeDelay, windowTitle, }?: Partial<BrowserHistoryArgs<TRouteState>>): BrowserHistory<TRouteState>;
+declare function historyRouter<TRouteState = UiState>({ createURL, parseURL, writeDelay, windowTitle, getLocation, }?: Partial<BrowserHistoryArgs<TRouteState>>): BrowserHistory<TRouteState>;
 
 declare type Hit = {
     __position: number;
@@ -2191,13 +2204,11 @@ declare type InitOptions = SharedRenderOptions & {
  */
 declare function insights(method: InsightsClientMethod, payload: Partial<InsightsClientPayload>): string;
 
-declare type InsightsAddAlgoliaAgent = (method: 'addAlgoliaAgent', algoliaAgent: string) => void;
-
-declare type InsightsClient = InsightsAddAlgoliaAgent & InsightsSendEvent & InsightsOnUserTokenChange & InsightsInit & InsightsSetUserToken & InsightsGetUserToken & {
-    queue?: Array<[string, any]>;
+declare type InsightsClient = InsightsClient_2 & {
+    queue?: QueueItem[];
 };
 
-declare type InsightsClientMethod = 'viewedObjectIDs' | 'clickedFilters' | 'clickedObjectIDsAfterSearch' | 'convertedObjectIDsAfterSearch';
+declare type InsightsClientMethod = keyof InsightsMethodMap;
 
 declare type InsightsClientPayload = {
     eventName: string;
@@ -2216,17 +2227,6 @@ declare type InsightsEvent = {
     attribute?: string;
 };
 
-declare type InsightsGetUserToken = (method: 'getUserToken', options?: any, callback?: (error: any, userToken: string) => void) => void;
-
-declare type InsightsInit = (method: 'init', options: {
-    appId: string;
-    apiKey: string;
-}) => void;
-
-declare type InsightsOnUserTokenChange = (method: 'onUserTokenChange', callback?: (userToken: string) => void, options?: {
-    immediate?: boolean;
-}) => void;
-
 declare type InsightsProps = {
     insightsClient: null | InsightsClient;
     insightsInitParams?: {
@@ -2238,10 +2238,6 @@ declare type InsightsProps = {
     onEvent?: (event: InsightsEvent, insightsClient: null | InsightsClient) => void;
 };
 
-declare type InsightsSendEvent = (method: InsightsClientMethod, payload: InsightsClientPayload) => void;
-
-declare type InsightsSetUserToken = (method: 'setUserToken', userToken: string) => void;
-
 /**
  * The actual implementation of the InstantSearch. This is
  * created using the `instantsearch` factory function.
@@ -3343,6 +3339,15 @@ declare type QueryRulesWidgetDescription = {
     };
 };
 
+declare type QueueItem = QueueItemMap[keyof QueueItemMap];
+
+declare type QueueItemMap = {
+    [MethodName in keyof InsightsMethodMap]: [
+    methodName: MethodName,
+    ...args: InsightsMethodMap[MethodName]
+    ];
+};
+
 declare type Range_2 = {
     min: RangeMin;
     max: RangeMax;
@@ -5005,6 +5010,8 @@ declare type UiState = {
 
 declare type UiStateLifeCycle<TWidgetDescription extends WidgetDescription> = TWidgetDescription extends RequiredKeys<WidgetDescription, 'indexUiState'> ? RequiredUiStateLifeCycle<TWidgetDescription> : Partial<RequiredUiStateLifeCycle<TWidgetDescription>>;
 
+declare type UnknownWidgetParams = NonNullable<object>;
+
 /**
  * The called function when unmounting a widget.
  */
@@ -5102,7 +5109,6 @@ declare type VoiceSearchWidgetParams = {
 
 declare type Widget<TWidgetDescription extends WidgetDescription & WidgetParams = {
     $$type: string;
-    widgetParams: unknown;
 }> = Expand<RequiredWidgetLifeCycle<TWidgetDescription> & WidgetType<TWidgetDescription> & UiStateLifeCycle<TWidgetDescription> & RenderStateLifeCycle<TWidgetDescription>>;
 
 declare type WidgetDescription = {
@@ -5116,7 +5122,7 @@ declare type WidgetDescription = {
 /**
  * The function that creates a new widget.
  */
-declare type WidgetFactory<TWidgetDescription extends WidgetDescription, TConnectorParams, TWidgetParams> = (
+declare type WidgetFactory<TWidgetDescription extends WidgetDescription, TConnectorParams extends UnknownWidgetParams, TWidgetParams extends UnknownWidgetParams> = (
 /**
  * The params of the widget.
  */
@@ -5125,7 +5131,7 @@ widgetParams: TWidgetParams & TConnectorParams) => Widget<TWidgetDescription & {
 }>;
 
 declare type WidgetParams = {
-    widgetParams: NonNullable<unknown>;
+    widgetParams?: UnknownWidgetParams;
 };
 
 declare type WidgetRenderState<TWidgetRenderState, TWidgetParams> = TWidgetRenderState & {