instantsearch.js 4.40.5 → 4.41.1

package/dist/instantsearch.production.d.ts

@@ -2003,9 +2003,15 @@ declare type HTMLMarkerArguments = {
 
 declare const index: (widgetParams: IndexWidgetParams) => IndexWidget;
 
-declare type IndexInitOptions = Pick<InitOptions, 'instantSearchInstance' | 'parent' | 'uiState'>;
+declare type IndexInitOptions = {
+    instantSearchInstance: InstantSearch;
+    parent: IndexWidget | null;
+    uiState: UiState;
+};
 
-declare type IndexRenderOptions = Pick<RenderOptions, 'instantSearchInstance'>;
+declare type IndexRenderOptions = {
+    instantSearchInstance: InstantSearch;
+};
 
 declare type IndexRenderState = Partial<ConnectorRenderStates & WidgetRenderStates>;
 
@@ -2280,7 +2286,7 @@ declare class InstantSearch<TUiState extends UiState = UiState, TRouteState = TU
     client: InstantSearchOptions['searchClient'];
     indexName: string;
     insightsClient: InsightsClient | null;
-    onStateChange: InstantSearchOptions['onStateChange'] | null;
+    onStateChange: InstantSearchOptions<TUiState>['onStateChange'] | null;
     helper: AlgoliaSearchHelper | null;
     mainHelper: AlgoliaSearchHelper | null;
     mainIndex: IndexWidget;
@@ -2290,9 +2296,9 @@ declare class InstantSearch<TUiState extends UiState = UiState, TRouteState = TU
     _stalledSearchDelay: number;
     _searchStalledTimer: any;
     _isSearchStalled: boolean;
-    _initialUiState: UiState;
+    _initialUiState: TUiState;
     _initialResults: InitialResults | null;
-    _createURL: CreateURL<UiState>;
+    _createURL: CreateURL<TUiState>;
     _searchFunction?: InstantSearchOptions['searchFunction'];
     _mainHelperSearch?: AlgoliaSearchHelper['search'];
     middleware: Array<{
@@ -2362,13 +2368,13 @@ declare class InstantSearch<TUiState extends UiState = UiState, TRouteState = TU
         cancel(): void;
     };
     scheduleStalledRender(): void;
-    setUiState(uiState: UiState | ((previousUiState: UiState) => UiState)): void;
-    getUiState(): UiState;
+    setUiState(uiState: TUiState | ((previousUiState: TUiState) => TUiState)): void;
+    getUiState(): TUiState;
     onInternalStateChange: ((...args: any[]) => void) & {
         wait(): Promise<void>;
         cancel(): void;
     };
-    createURL(nextState?: UiState): string;
+    createURL(nextState?: TUiState): string;
     refresh(): void;
 }
 
@@ -2460,8 +2466,8 @@ declare type InstantSearchOptions<TUiState extends UiState = UiState, TRouteStat
      * become in charge of updating the UI state with the `setUiState` function.
      */
     onStateChange?: (params: {
-        uiState: UiState;
-        setUiState(uiState: UiState | ((previousUiState: UiState) => UiState)): void;
+        uiState: TUiState;
+        setUiState(uiState: TUiState | ((previousUiState: TUiState) => TUiState)): void;
     }) => void;
     /**
      * Injects a `uiState` to the `instantsearch` instance. You can use this option
@@ -2469,7 +2475,7 @@ declare type InstantSearchOptions<TUiState extends UiState = UiState, TRouteStat
      * for the first search. To unconditionally pass additional parameters to the
      * Algolia API, take a look at the `configure` widget.
      */
-    initialUiState?: TUiState;
+    initialUiState?: NoInfer<TUiState>;
     /**
      * Time before a search is considered stalled. The default is 200ms
      */
@@ -2773,6 +2779,8 @@ declare namespace middlewares {
     }
 }
 
+declare type NoInfer<T> = [T][T extends any ? 0 : never];
+
 declare const numericMenu: NumericMenuWidget;
 
 declare type NumericMenuComponentCSSClasses = ComponentCSSClasses<NumericMenuCSSClasses>;
@@ -4595,7 +4603,7 @@ declare type SendEventForToggle = BuiltInSendEventForToggle & CustomSendEventFor
 
 declare type SharedRenderOptions = {
     instantSearchInstance: InstantSearch;
-    parent: IndexWidget | null;
+    parent: IndexWidget;
     templatesConfig: Record<string, unknown>;
     scopedResults: ScopedResult[];
     state: SearchParameters;

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

@@ -2003,9 +2003,15 @@ declare type HTMLMarkerArguments = {
 
 declare const index: (widgetParams: IndexWidgetParams) => IndexWidget;
 
-declare type IndexInitOptions = Pick<InitOptions, 'instantSearchInstance' | 'parent' | 'uiState'>;
+declare type IndexInitOptions = {
+    instantSearchInstance: InstantSearch;
+    parent: IndexWidget | null;
+    uiState: UiState;
+};
 
-declare type IndexRenderOptions = Pick<RenderOptions, 'instantSearchInstance'>;
+declare type IndexRenderOptions = {
+    instantSearchInstance: InstantSearch;
+};
 
 declare type IndexRenderState = Partial<ConnectorRenderStates & WidgetRenderStates>;
 
@@ -2280,7 +2286,7 @@ declare class InstantSearch<TUiState extends UiState = UiState, TRouteState = TU
     client: InstantSearchOptions['searchClient'];
     indexName: string;
     insightsClient: InsightsClient | null;
-    onStateChange: InstantSearchOptions['onStateChange'] | null;
+    onStateChange: InstantSearchOptions<TUiState>['onStateChange'] | null;
     helper: AlgoliaSearchHelper | null;
     mainHelper: AlgoliaSearchHelper | null;
     mainIndex: IndexWidget;
@@ -2290,9 +2296,9 @@ declare class InstantSearch<TUiState extends UiState = UiState, TRouteState = TU
     _stalledSearchDelay: number;
     _searchStalledTimer: any;
     _isSearchStalled: boolean;
-    _initialUiState: UiState;
+    _initialUiState: TUiState;
     _initialResults: InitialResults | null;
-    _createURL: CreateURL<UiState>;
+    _createURL: CreateURL<TUiState>;
     _searchFunction?: InstantSearchOptions['searchFunction'];
     _mainHelperSearch?: AlgoliaSearchHelper['search'];
     middleware: Array<{
@@ -2362,13 +2368,13 @@ declare class InstantSearch<TUiState extends UiState = UiState, TRouteState = TU
         cancel(): void;
     };
     scheduleStalledRender(): void;
-    setUiState(uiState: UiState | ((previousUiState: UiState) => UiState)): void;
-    getUiState(): UiState;
+    setUiState(uiState: TUiState | ((previousUiState: TUiState) => TUiState)): void;
+    getUiState(): TUiState;
     onInternalStateChange: ((...args: any[]) => void) & {
         wait(): Promise<void>;
         cancel(): void;
     };
-    createURL(nextState?: UiState): string;
+    createURL(nextState?: TUiState): string;
     refresh(): void;
 }
 
@@ -2460,8 +2466,8 @@ declare type InstantSearchOptions<TUiState extends UiState = UiState, TRouteStat
      * become in charge of updating the UI state with the `setUiState` function.
      */
     onStateChange?: (params: {
-        uiState: UiState;
-        setUiState(uiState: UiState | ((previousUiState: UiState) => UiState)): void;
+        uiState: TUiState;
+        setUiState(uiState: TUiState | ((previousUiState: TUiState) => TUiState)): void;
     }) => void;
     /**
      * Injects a `uiState` to the `instantsearch` instance. You can use this option
@@ -2469,7 +2475,7 @@ declare type InstantSearchOptions<TUiState extends UiState = UiState, TRouteStat
      * for the first search. To unconditionally pass additional parameters to the
      * Algolia API, take a look at the `configure` widget.
      */
-    initialUiState?: TUiState;
+    initialUiState?: NoInfer<TUiState>;
     /**
      * Time before a search is considered stalled. The default is 200ms
      */
@@ -2773,6 +2779,8 @@ declare namespace middlewares {
     }
 }
 
+declare type NoInfer<T> = [T][T extends any ? 0 : never];
+
 declare const numericMenu: NumericMenuWidget;
 
 declare type NumericMenuComponentCSSClasses = ComponentCSSClasses<NumericMenuCSSClasses>;
@@ -4595,7 +4603,7 @@ declare type SendEventForToggle = BuiltInSendEventForToggle & CustomSendEventFor
 
 declare type SharedRenderOptions = {
     instantSearchInstance: InstantSearch;
-    parent: IndexWidget | null;
+    parent: IndexWidget;
     templatesConfig: Record<string, unknown>;
     scopedResults: ScopedResult[];
     state: SearchParameters;