instantsearch.js 4.72.1 → 4.73.0

package/es/connectors/trending-items/connectTrendingItems.d.ts

@@ -1,4 +1,4 @@
-import type { Connector, TransformItems, Hit, BaseHit, Renderer, Unmounter } from '../../types';
+import type { Connector, TransformItems, Hit, BaseHit, Renderer, Unmounter, UnknownWidgetParams } from '../../types';
 import type { PlainSearchParameters, RecommendResultItem } from 'algoliasearch-helper';
 export type TrendingItemsRenderState<THit extends NonNullable<object> = BaseHit> = {
     /**
@@ -53,7 +53,7 @@ export type TrendingItemsWidgetDescription<THit extends NonNullable<object> = Ba
     renderState: TrendingItemsRenderState<THit>;
 };
 export type TrendingItemsConnector<THit extends NonNullable<object> = BaseHit> = Connector<TrendingItemsWidgetDescription<THit>, TrendingItemsConnectorParams<THit>>;
-declare const _default: <TWidgetParams extends object>(renderFn: Renderer<TrendingItemsRenderState<BaseHit>, TWidgetParams & TrendingItemsConnectorParams<BaseHit>>, unmountFn?: Unmounter) => <THit extends object = BaseHit>(widgetParams: TWidgetParams & TrendingItemsConnectorParams<THit>) => {
+declare const _default: <TWidgetParams extends UnknownWidgetParams>(renderFn: Renderer<TrendingItemsRenderState, TWidgetParams & TrendingItemsConnectorParams>, unmountFn?: Unmounter) => <THit extends NonNullable<object> = BaseHit>(widgetParams: TWidgetParams & TrendingItemsConnectorParams<THit>) => {
     dependsOn: "recommend";
     $$type: "ais.trendingItems";
     init(initOptions: import("../../types").InitOptions): void;
@@ -148,204 +148,19 @@ declare const _default: <TWidgetParams extends object>(renderFn: Renderer<Trendi
         places?: import("../../types").WidgetRenderState<Record<string, unknown>, import("../../widgets/places/places").PlacesWidgetParams> | undefined;
     };
     getWidgetRenderState({ results }: import("../../types").InitOptions | import("../../types").RenderOptions | ({
-        /**
-         * The matched recommendations from the Algolia API.
-         */
-        instantSearchInstance: import("../../lib/InstantSearch").default<import("../../types").UiState, import("../../types").UiState>;
+        instantSearchInstance: import("../../types").InstantSearch;
         parent: import("../../types").IndexWidget;
         templatesConfig: Record<string, unknown>;
         scopedResults: import("../../types").ScopedResult[];
         state: import("algoliasearch-helper").SearchParameters;
-        renderState: Partial<{
-            answers: import("../../types").WidgetRenderState<import("../answers/connectAnswers").AnswersRenderState, import("../answers/connectAnswers").AnswersConnectorParams>;
-        } & {
-            autocomplete: import("../../types").WidgetRenderState<import("../autocomplete/connectAutocomplete").AutocompleteRenderState, import("../autocomplete/connectAutocomplete").AutocompleteConnectorParams>;
-        } & {
-            breadcrumb: {
-                [rootAttribute: string]: import("../../types").WidgetRenderState<import("../breadcrumb/connectBreadcrumb").BreadcrumbRenderState, import("../breadcrumb/connectBreadcrumb").BreadcrumbConnectorParams>;
-            };
-        } & {
-            clearRefinements: import("../../types").WidgetRenderState<import("../clear-refinements/connectClearRefinements").ClearRefinementsRenderState, import("../clear-refinements/connectClearRefinements").ClearRefinementsConnectorParams>;
-        } & {
-            configure: import("../../types").WidgetRenderState<import("../configure/connectConfigure").ConfigureRenderState, import("../configure/connectConfigure").ConfigureConnectorParams>;
-        } & {
-            currentRefinements: import("../../types").WidgetRenderState<import("../current-refinements/connectCurrentRefinements").CurrentRefinementsRenderState, import("../current-refinements/connectCurrentRefinements").CurrentRefinementsConnectorParams>;
-        } & {
-            geoSearch: import("../../types").WidgetRenderState<import("../geo-search/connectGeoSearch").GeoSearchRenderState<import("../../types").GeoHit>, import("../geo-search/connectGeoSearch").GeoSearchConnectorParams<import("../../types").GeoHit>>;
-        } & {
-            hierarchicalMenu: {
-                [rootAttribute: string]: import("../../types").WidgetRenderState<import("../hierarchical-menu/connectHierarchicalMenu").HierarchicalMenuRenderState, import("../hierarchical-menu/connectHierarchicalMenu").HierarchicalMenuConnectorParams>;
-            };
-        } & {
-            hits: import("../../types").WidgetRenderState<import("../hits/connectHits").HitsRenderState<BaseHit>, import("../hits/connectHits").HitsConnectorParams<BaseHit>>;
-        } & {
-            hitsPerPage: import("../../types").WidgetRenderState<import("../hits-per-page/connectHitsPerPage").HitsPerPageRenderState, import("../hits-per-page/connectHitsPerPage").HitsPerPageConnectorParams>;
-        } & {
-            infiniteHits: import("../../types").WidgetRenderState<import("../infinite-hits/connectInfiniteHits").InfiniteHitsRenderState<BaseHit>, import("../infinite-hits/connectInfiniteHits").InfiniteHitsConnectorParams<BaseHit>>;
-        } & {
-            menu: {
-                [attribute: string]: import("../../types").WidgetRenderState<import("../menu/connectMenu").MenuRenderState, import("../menu/connectMenu").MenuConnectorParams>;
-            };
-        } & {
-            numericMenu: {
-                [attribute: string]: import("../../types").WidgetRenderState<import("../numeric-menu/connectNumericMenu").NumericMenuRenderState, import("../numeric-menu/connectNumericMenu").NumericMenuConnectorParams>;
-            };
-        } & {
-            pagination: import("../../types").WidgetRenderState<import("../pagination/connectPagination").PaginationRenderState, import("../pagination/connectPagination").PaginationConnectorParams>;
-        } & {
-            poweredBy: import("../../types").WidgetRenderState<import("../powered-by/connectPoweredBy").PoweredByRenderState, import("../powered-by/connectPoweredBy").PoweredByConnectorParams>;
-        } & {
-            queryRules: import("../../types").WidgetRenderState<import("../query-rules/connectQueryRules").QueryRulesRenderState, import("../query-rules/connectQueryRules").QueryRulesConnectorParams>;
-        } & {
-            range: {
-                [attribute: string]: import("../../types").WidgetRenderState<import("../range/connectRange").RangeRenderState, import("../range/connectRange").RangeConnectorParams>;
-            };
-        } & {
-            ratingMenu: {
-                [attribute: string]: import("../../types").WidgetRenderState<import("../rating-menu/connectRatingMenu").RatingMenuRenderState, import("../rating-menu/connectRatingMenu").RatingMenuConnectorParams>;
-            };
-        } & {
-            refinementList: {
-                [attribute: string]: import("../../types").WidgetRenderState<import("../refinement-list/connectRefinementList").RefinementListRenderState, import("../refinement-list/connectRefinementList").RefinementListConnectorParams>;
-            };
-        } & {
-            relevantSort: import("../../types").WidgetRenderState<import("../relevant-sort/connectRelevantSort").RelevantSortRenderState, import("../relevant-sort/connectRelevantSort").RelevantSortConnectorParams>;
-        } & {
-            searchBox: import("../../types").WidgetRenderState<import("../search-box/connectSearchBox").SearchBoxRenderState, import("../search-box/connectSearchBox").SearchBoxConnectorParams>;
-        } & {
-            sortBy: import("../../types").WidgetRenderState<import("../sort-by/connectSortBy").SortByRenderState, import("../sort-by/connectSortBy").SortByConnectorParams>;
-        } & {
-            stats: import("../../types").WidgetRenderState<import("../stats/connectStats").StatsRenderState, import("../stats/connectStats").StatsConnectorParams>;
-        } & {
-            toggleRefinement: {
-                [attribute: string]: import("../../types").WidgetRenderState<import("../toggle-refinement/connectToggleRefinement").ToggleRefinementRenderState, import("../toggle-refinement/connectToggleRefinement").ToggleRefinementConnectorParams>;
-            };
-        } & {
-            voiceSearch: import("../../types").WidgetRenderState<import("../voice-search/connectVoiceSearch").VoiceSearchRenderState, import("../voice-search/connectVoiceSearch").VoiceSearchConnectorParams>;
-        } & {
-            analytics: import("../../types").WidgetRenderState<Record<string, unknown>, import("../../widgets/analytics/analytics").AnalyticsWidgetParams>;
-        } & {
-            places: import("../../types").WidgetRenderState<Record<string, unknown>, import("../../widgets/places/places").PlacesWidgetParams>;
-        }>; /**
-         * The facet attribute to get recommendations for.
-         */
+        renderState: import("../../types").IndexRenderState;
         helper: import("algoliasearch-helper").AlgoliaSearchHelper;
         searchMetadata: {
             isSearchStalled: boolean;
         };
-        status: import("../../types").InstantSearchStatus;
-        error: Error | undefined;
-        createURL: (nextState: import("algoliasearch-helper").SearchParameters | ((state: Partial<{
-            query: string;
-        } & {
-            configure: PlainSearchParameters;
-        } & {
-            geoSearch: {
-                boundingBox: string;
-            };
-        } & {
-            hierarchicalMenu: {
-                [rootAttribute: string]: string[];
-            };
-        } & {
-            hitsPerPage: number;
-        } & {
-            page: number;
-        } & {
-            menu: {
-                [attribute: string]: string;
-            };
-        } & {
-            numericMenu: {
-                [attribute: string]: string;
-            };
-        } & {
-            page: number;
-        } & {
-            range: {
-                [attribute: string]: string;
-            };
-        } & {
-            ratingMenu: {
-                [attribute: string]: number | undefined;
-            };
-        } & {
-            refinementList: {
-                [attribute: string]: string[];
-            };
-        } & {
-            relevantSort: number;
-        } & {
-            query: string;
-        } & {
-            sortBy: string;
-        } & {
-            toggle: {
-                [attribute: string]: boolean;
-            };
-        } & {
-            query: string;
-        } & {
-            places: {
-                query: string;
-                position: string;
-            };
-        }>) => Partial<{
-            query: string;
-        } & {
-            configure: PlainSearchParameters;
-        } & {
-            geoSearch: {
-                boundingBox: string;
-            };
-        } & {
-            hierarchicalMenu: {
-                [rootAttribute: string]: string[];
-            };
-        } & {
-            hitsPerPage: number;
-        } & {
-            page: number;
-        } & {
-            menu: {
-                [attribute: string]: string;
-            };
-        } & {
-            numericMenu: {
-                [attribute: string]: string;
-            };
-        } & {
-            page: number;
-        } & {
-            range: {
-                [attribute: string]: string;
-            };
-        } & {
-            ratingMenu: {
-                [attribute: string]: number | undefined;
-            };
-        } & {
-            refinementList: {
-                [attribute: string]: string[];
-            };
-        } & {
-            relevantSort: number;
-        } & {
-            query: string;
-        } & {
-            sortBy: string;
-        } & {
-            toggle: {
-                [attribute: string]: boolean;
-            };
-        } & {
-            query: string;
-        } & {
-            places: {
-                query: string;
-                position: string;
-            };
-        }>)) => string;
+        status: import("../../types").InstantSearch["status"];
+        error: import("../../types").InstantSearch["error"];
+        createURL: (nextState: import("algoliasearch-helper").SearchParameters | ((state: import("../../types").IndexUiState) => import("../../types").IndexUiState)) => string;
     } & {
         results: RecommendResultItem;
     })): {

package/es/lib/insights/client.d.ts

@@ -5,7 +5,7 @@ export declare const inferPayload: ({ method, results, hits, objectIDs, }: {
     results: SearchResults;
     hits: Hit[];
     objectIDs: string[];
-}) => Omit<InsightsClientPayload, 'eventName'>;
+}) => Omit<InsightsClientPayload, "eventName">;
 /**
  * @deprecated This function will be still supported in 4.x releases, but not further. It is replaced by the `insights` middleware. For more information, visit https://www.algolia.com/doc/guides/getting-insights-and-analytics/search-analytics/click-through-and-conversions/how-to/send-click-and-conversion-events-with-instantsearch/js/
  * It passes `insights` to `HitsWithInsightsListener` and `InfiniteHitsWithInsightsListener`.

package/es/lib/utils/createConcurrentSafePromise.d.ts

@@ -5,4 +5,4 @@ export type MaybePromise<TResolution> = Readonly<Promise<TResolution>> | Promise
  * This is useful to prevent older promises to resolve after a newer promise,
  * otherwise resulting in stale resolved values.
  */
-export declare function createConcurrentSafePromise<TValue>(): (promise: MaybePromise<TValue>) => Promise<NonNullable<TValue> | Awaited<TValue>>;
+export declare function createConcurrentSafePromise<TValue>(): (promise: MaybePromise<TValue>) => Promise<Awaited<TValue> | NonNullable<TValue>>;

package/es/lib/utils/render-args.d.ts

@@ -7,117 +7,7 @@ export declare function createInitArgs(instantSearchInstance: InstantSearch, par
     state: import("algoliasearch-helper").SearchParameters;
     renderState: import("../../types").RenderState;
     templatesConfig: Record<string, unknown>;
-    createURL: (nextState: import("algoliasearch-helper").SearchParameters | ((state: Partial<{
-        query: string;
-    } & {
-        configure: import("algoliasearch-helper").PlainSearchParameters;
-    } & {
-        geoSearch: {
-            boundingBox: string;
-        };
-    } & {
-        hierarchicalMenu: {
-            [rootAttribute: string]: string[];
-        };
-    } & {
-        hitsPerPage: number;
-    } & {
-        page: number;
-    } & {
-        menu: {
-            [attribute: string]: string;
-        };
-    } & {
-        numericMenu: {
-            [attribute: string]: string;
-        };
-    } & {
-        page: number;
-    } & {
-        range: {
-            [attribute: string]: string;
-        };
-    } & {
-        ratingMenu: {
-            [attribute: string]: number | undefined;
-        };
-    } & {
-        refinementList: {
-            [attribute: string]: string[];
-        };
-    } & {
-        relevantSort: number;
-    } & {
-        query: string;
-    } & {
-        sortBy: string;
-    } & {
-        toggle: {
-            [attribute: string]: boolean;
-        };
-    } & {
-        query: string;
-    } & {
-        places: {
-            query: string;
-            position: string;
-        };
-    }>) => Partial<{
-        query: string;
-    } & {
-        configure: import("algoliasearch-helper").PlainSearchParameters;
-    } & {
-        geoSearch: {
-            boundingBox: string;
-        };
-    } & {
-        hierarchicalMenu: {
-            [rootAttribute: string]: string[];
-        };
-    } & {
-        hitsPerPage: number;
-    } & {
-        page: number;
-    } & {
-        menu: {
-            [attribute: string]: string;
-        };
-    } & {
-        numericMenu: {
-            [attribute: string]: string;
-        };
-    } & {
-        page: number;
-    } & {
-        range: {
-            [attribute: string]: string;
-        };
-    } & {
-        ratingMenu: {
-            [attribute: string]: number | undefined;
-        };
-    } & {
-        refinementList: {
-            [attribute: string]: string[];
-        };
-    } & {
-        relevantSort: number;
-    } & {
-        query: string;
-    } & {
-        sortBy: string;
-    } & {
-        toggle: {
-            [attribute: string]: boolean;
-        };
-    } & {
-        query: string;
-    } & {
-        places: {
-            query: string;
-            position: string;
-        };
-    }>)) => string;
+    createURL: (nextState: import("algoliasearch-helper").SearchParameters | ((state: import("../../types").IndexUiState) => import("../../types").IndexUiState)) => string;
     scopedResults: never[];
     searchMetadata: {
         isSearchStalled: boolean;
@@ -134,117 +24,7 @@ export declare function createRenderArgs(instantSearchInstance: InstantSearch, p
     state: import("algoliasearch-helper").SearchParameters;
     renderState: import("../../types").RenderState;
     templatesConfig: Record<string, unknown>;
-    createURL: (nextState: import("algoliasearch-helper").SearchParameters | ((state: Partial<{
-        query: string;
-    } & {
-        configure: import("algoliasearch-helper").PlainSearchParameters;
-    } & {
-        geoSearch: {
-            boundingBox: string;
-        };
-    } & {
-        hierarchicalMenu: {
-            [rootAttribute: string]: string[];
-        };
-    } & {
-        hitsPerPage: number;
-    } & {
-        page: number;
-    } & {
-        menu: {
-            [attribute: string]: string;
-        };
-    } & {
-        numericMenu: {
-            [attribute: string]: string;
-        };
-    } & {
-        page: number;
-    } & {
-        range: {
-            [attribute: string]: string;
-        };
-    } & {
-        ratingMenu: {
-            [attribute: string]: number | undefined;
-        };
-    } & {
-        refinementList: {
-            [attribute: string]: string[];
-        };
-    } & {
-        relevantSort: number;
-    } & {
-        query: string;
-    } & {
-        sortBy: string;
-    } & {
-        toggle: {
-            [attribute: string]: boolean;
-        };
-    } & {
-        query: string;
-    } & {
-        places: {
-            query: string;
-            position: string;
-        };
-    }>) => Partial<{
-        query: string;
-    } & {
-        configure: import("algoliasearch-helper").PlainSearchParameters;
-    } & {
-        geoSearch: {
-            boundingBox: string;
-        };
-    } & {
-        hierarchicalMenu: {
-            [rootAttribute: string]: string[];
-        };
-    } & {
-        hitsPerPage: number;
-    } & {
-        page: number;
-    } & {
-        menu: {
-            [attribute: string]: string;
-        };
-    } & {
-        numericMenu: {
-            [attribute: string]: string;
-        };
-    } & {
-        page: number;
-    } & {
-        range: {
-            [attribute: string]: string;
-        };
-    } & {
-        ratingMenu: {
-            [attribute: string]: number | undefined;
-        };
-    } & {
-        refinementList: {
-            [attribute: string]: string[];
-        };
-    } & {
-        relevantSort: number;
-    } & {
-        query: string;
-    } & {
-        sortBy: string;
-    } & {
-        toggle: {
-            [attribute: string]: boolean;
-        };
-    } & {
-        query: string;
-    } & {
-        places: {
-            query: string;
-            position: string;
-        };
-    }>)) => string;
+    createURL: (nextState: import("algoliasearch-helper").SearchParameters | ((state: import("../../types").IndexUiState) => import("../../types").IndexUiState)) => string;
     searchMetadata: {
         isSearchStalled: boolean;
     };

package/es/lib/utils/typedObject.d.ts

@@ -2,4 +2,4 @@
  * A typed version of Object.keys, to use when looping over a static object
  * inspired from https://stackoverflow.com/a/65117465/3185307
  */
-export declare const keys: <TObject extends Record<string, unknown>>(yourObject: TObject) => (keyof TObject)[];
+export declare const keys: <TObject extends Record<string, unknown>>(yourObject: TObject) => Array<keyof TObject>;

package/es/lib/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "4.72.1";
+declare const _default: "4.73.0";
 export default _default;

package/es/lib/version.js

@@ -1 +1 @@
-export default '4.72.1';
+export default '4.73.0';

package/es/widgets/frequently-bought-together/frequently-bought-together.d.ts

@@ -37,7 +37,7 @@ type FrequentlyBoughtTogetherWidgetParams<THit extends NonNullable<object> = Bas
 export type FrequentlyBoughtTogetherWidget = WidgetFactory<FrequentlyBoughtTogetherWidgetDescription & {
     $$widgetType: 'ais.frequentlyBoughtTogether';
 }, FrequentlyBoughtTogetherConnectorParams, FrequentlyBoughtTogetherWidgetParams>;
-declare const _default: <THit extends object = BaseHit>(widgetParams: FrequentlyBoughtTogetherWidgetParams<THit> & FrequentlyBoughtTogetherConnectorParams<THit>) => {
+declare const _default: <THit extends NonNullable<object> = BaseHit>(widgetParams: FrequentlyBoughtTogetherWidgetParams<THit> & FrequentlyBoughtTogetherConnectorParams<THit>) => {
     $$widgetType: "ais.frequentlyBoughtTogether";
     dependsOn: "recommend";
     $$type: "ais.frequentlyBoughtTogether";
@@ -133,7 +133,7 @@ declare const _default: <THit extends object = BaseHit>(widgetParams: Frequently
         places?: import("../../types").WidgetRenderState<Record<string, unknown>, import("../places/places").PlacesWidgetParams> | undefined;
     };
     getWidgetRenderState({ results }: import("../../types").InitOptions | import("../../types").RenderOptions | ({
-        instantSearchInstance: import("../../lib/InstantSearch").default<import("../../types").UiState, import("../../types").UiState>;
+        instantSearchInstance: import("../../types").InstantSearch;
         parent: import("../index").IndexWidget;
         templatesConfig: Record<string, unknown>;
         scopedResults: import("../../types").ScopedResult[];
@@ -213,119 +213,9 @@ declare const _default: <THit extends object = BaseHit>(widgetParams: Frequently
         searchMetadata: {
             isSearchStalled: boolean;
         };
-        status: import("../../types").InstantSearchStatus;
-        error: Error | undefined;
-        createURL: (nextState: import("algoliasearch-helper").SearchParameters | ((state: Partial<{
-            query: string;
-        } & {
-            configure: import("algoliasearch-helper").PlainSearchParameters;
-        } & {
-            geoSearch: {
-                boundingBox: string;
-            };
-        } & {
-            hierarchicalMenu: {
-                [rootAttribute: string]: string[];
-            };
-        } & {
-            hitsPerPage: number;
-        } & {
-            page: number;
-        } & {
-            menu: {
-                [attribute: string]: string;
-            };
-        } & {
-            numericMenu: {
-                [attribute: string]: string;
-            };
-        } & {
-            page: number;
-        } & {
-            range: {
-                [attribute: string]: string;
-            };
-        } & {
-            ratingMenu: {
-                [attribute: string]: number | undefined;
-            };
-        } & {
-            refinementList: {
-                [attribute: string]: string[];
-            };
-        } & {
-            relevantSort: number;
-        } & {
-            query: string;
-        } & {
-            sortBy: string;
-        } & {
-            toggle: {
-                [attribute: string]: boolean;
-            };
-        } & {
-            query: string;
-        } & {
-            places: {
-                query: string;
-                position: string;
-            };
-        }>) => Partial<{
-            query: string;
-        } & {
-            configure: import("algoliasearch-helper").PlainSearchParameters;
-        } & {
-            geoSearch: {
-                boundingBox: string;
-            };
-        } & {
-            hierarchicalMenu: {
-                [rootAttribute: string]: string[];
-            };
-        } & {
-            hitsPerPage: number;
-        } & {
-            page: number;
-        } & {
-            menu: {
-                [attribute: string]: string;
-            };
-        } & {
-            numericMenu: {
-                [attribute: string]: string;
-            };
-        } & {
-            page: number;
-        } & {
-            range: {
-                [attribute: string]: string;
-            };
-        } & {
-            ratingMenu: {
-                [attribute: string]: number | undefined;
-            };
-        } & {
-            refinementList: {
-                [attribute: string]: string[];
-            };
-        } & {
-            relevantSort: number;
-        } & {
-            query: string;
-        } & {
-            sortBy: string;
-        } & {
-            toggle: {
-                [attribute: string]: boolean;
-            };
-        } & {
-            query: string;
-        } & {
-            places: {
-                query: string;
-                position: string;
-            };
-        }>)) => string;
+        status: import("../../types").InstantSearch["status"];
+        error: import("../../types").InstantSearch["error"];
+        createURL: (nextState: import("algoliasearch-helper").SearchParameters | ((state: import("../../types").IndexUiState) => import("../../types").IndexUiState)) => string;
     } & {
         results: RecommendResultItem;
     })): {

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

@@ -1,5 +1,3 @@
-/// <reference types="google.maps" />
-/// <reference types="googlemaps" />
 import type { renderTemplate } from '../../lib/templating';
 export type HTMLMarkerArguments = {
     __id: string;