instantsearch.js 4.42.0 → 4.44.0

package/dist/instantsearch.production.d.ts

@@ -1,14 +1,14 @@
 /// <reference types="google.maps" />
 
-import type algoliasearch from 'algoliasearch/lite';
 import type { AlgoliaSearchHelper } from 'algoliasearch-helper';
-import type * as ClientSearch from '@algolia/client-search';
 import EventEmitter from '@algolia/events';
+import { FindAnswersOptions } from 'algoliasearch-helper/types/algoliasearch.js';
 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';
+import { SearchClient } from 'algoliasearch-helper/types/algoliasearch.js';
 import type { SearchParameters } from 'algoliasearch-helper';
 import type { SearchResults } from 'algoliasearch-helper';
 
@@ -34,7 +34,7 @@ declare type AlgoliaHit<THit extends BaseHit = Record<string, any>> = {
         };
     };
     _distinctSeqID?: number;
-    _geoLoc?: GeoLoc;
+    _geoloc?: GeoLoc;
 } & THit;
 
 declare const analytics: AnalyticsWidget;
@@ -1075,18 +1075,12 @@ declare type CustomSendEventForHits = (customPayload: any) => void;
 
 declare type CustomSendEventForToggle = (customPayload: any) => void;
 
-declare type DefaultSearchClient = ReturnType<typeof algoliasearch>;
-
 declare type DisposeOptions = {
     helper: AlgoliaSearchHelper;
     state: SearchParameters;
     parent: IndexWidget;
 };
 
-declare type DummySearchClientV4 = {
-    readonly transporter: any;
-};
-
 declare const dynamicWidgets: DynamicWidgetsWidget;
 
 declare type DynamicWidgetsConnector = Connector<DynamicWidgetsWidgetDescription, DynamicWidgetsConnectorParams>;
@@ -1175,9 +1169,7 @@ declare const EXPERIMENTAL_connectDynamicWidgets: DynamicWidgetsConnector;
 /** @deprecated use dynamicWidgets */
 declare const EXPERIMENTAL_dynamicWidgets: DynamicWidgetsWidget;
 
-declare type FindAnswersOptions = DefaultSearchClient extends DummySearchClientV4 ? ClientSearch.FindAnswersOptions : any;
-
-declare type GeoHit = Hit & Required<Pick<Hit, '_geoLoc'>>;
+declare type GeoHit<THit extends BaseHit = Record<string, any>> = Hit<THit> & Required<Pick<Hit, '_geoloc'>>;
 
 declare type GeoLoc = {
     lat: number;
@@ -1199,9 +1191,9 @@ declare type GeoLoc = {
  */
 declare const geoSearch: GeoSearchWidget;
 
-declare type GeoSearchConnector = Connector<GeoSearchWidgetDescription, GeoSearchConnectorParams>;
+declare type GeoSearchConnector<THit extends BaseHit = Record<string, any>> = Connector<GeoSearchWidgetDescription<THit>, GeoSearchConnectorParams<THit>>;
 
-declare type GeoSearchConnectorParams = {
+declare type GeoSearchConnectorParams<THit extends BaseHit = Record<string, any>> = {
     /**
      * If true, refine will be triggered as you move the map.
      * @default true
@@ -1211,7 +1203,7 @@ declare type GeoSearchConnectorParams = {
      * Function to transform the items passed to the templates.
      * @default items => items
      */
-    transformItems?: TransformItems<GeoHit>;
+    transformItems?: TransformItems<GeoHit<THit>>;
 };
 
 declare type GeoSearchCSSClasses = Partial<{
@@ -1257,7 +1249,7 @@ declare type GeoSearchMarker<TOptions> = {
     };
 };
 
-declare type GeoSearchRenderState = {
+declare type GeoSearchRenderState<THit extends BaseHit = Record<string, any>> = {
     /**
      * Reset the current bounding box refinement.
      */
@@ -1281,7 +1273,7 @@ declare type GeoSearchRenderState = {
     /**
      * The matched hits from Algolia API.
      */
-    items: GeoHit[];
+    items: Array<GeoHit<THit>>;
     /**
      * The current position of the search.
      */
@@ -1321,11 +1313,11 @@ declare type GeoSearchWidget = WidgetFactory<GeoSearchWidgetDescription & {
     $$widgetType: 'ais.geoSearch';
 }, GeoSearchConnectorParams, GeoSearchWidgetParams>;
 
-declare type GeoSearchWidgetDescription = {
+declare type GeoSearchWidgetDescription<THit extends BaseHit = Record<string, any>> = {
     $$type: 'ais.geoSearch';
-    renderState: GeoSearchRenderState;
+    renderState: GeoSearchRenderState<THit>;
     indexRenderState: {
-        geoSearch: WidgetRenderState<GeoSearchRenderState, GeoSearchConnectorParams>;
+        geoSearch: WidgetRenderState<GeoSearchRenderState<THit>, GeoSearchConnectorParams<THit>>;
     };
     indexUiState: {
         geoSearch: {
@@ -4582,17 +4574,6 @@ declare type SearchBoxWidgetParams = {
     queryHook?: (query: string, hook: (value: string) => void) => void;
 };
 
-declare type SearchClient = {
-    search: DefaultSearchClient['search'];
-    searchForFacetValues: DefaultSearchClient['searchForFacetValues'];
-    addAlgoliaAgent?: DefaultSearchClient['addAlgoliaAgent'];
-    initIndex?: (indexName: string) => SearchIndex extends {
-        findAnswers: any;
-    } ? Partial<Pick<SearchIndex, 'findAnswers'>> : SearchIndex;
-};
-
-declare type SearchIndex = ReturnType<DefaultSearchClient['initIndex']>;
-
 declare type SendEvent = (...args: [InsightsEvent] | [string, string, string?]) => void;
 
 declare type SendEventForFacet = BuiltInSendEventForFacet & CustomSendEventForFacet;

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

@@ -1,14 +1,14 @@
 /// <reference types="google.maps" />
 
-import type algoliasearch from 'algoliasearch/lite';
 import type { AlgoliaSearchHelper } from 'algoliasearch-helper';
-import type * as ClientSearch from '@algolia/client-search';
 import EventEmitter from '@algolia/events';
+import { FindAnswersOptions } from 'algoliasearch-helper/types/algoliasearch.js';
 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';
+import { SearchClient } from 'algoliasearch-helper/types/algoliasearch.js';
 import type { SearchParameters } from 'algoliasearch-helper';
 import type { SearchResults } from 'algoliasearch-helper';
 
@@ -34,7 +34,7 @@ declare type AlgoliaHit<THit extends BaseHit = Record<string, any>> = {
         };
     };
     _distinctSeqID?: number;
-    _geoLoc?: GeoLoc;
+    _geoloc?: GeoLoc;
 } & THit;
 
 declare const analytics: AnalyticsWidget;
@@ -1075,18 +1075,12 @@ declare type CustomSendEventForHits = (customPayload: any) => void;
 
 declare type CustomSendEventForToggle = (customPayload: any) => void;
 
-declare type DefaultSearchClient = ReturnType<typeof algoliasearch>;
-
 declare type DisposeOptions = {
     helper: AlgoliaSearchHelper;
     state: SearchParameters;
     parent: IndexWidget;
 };
 
-declare type DummySearchClientV4 = {
-    readonly transporter: any;
-};
-
 declare const dynamicWidgets: DynamicWidgetsWidget;
 
 declare type DynamicWidgetsConnector = Connector<DynamicWidgetsWidgetDescription, DynamicWidgetsConnectorParams>;
@@ -1175,9 +1169,7 @@ declare const EXPERIMENTAL_connectDynamicWidgets: DynamicWidgetsConnector;
 /** @deprecated use dynamicWidgets */
 declare const EXPERIMENTAL_dynamicWidgets: DynamicWidgetsWidget;
 
-declare type FindAnswersOptions = DefaultSearchClient extends DummySearchClientV4 ? ClientSearch.FindAnswersOptions : any;
-
-declare type GeoHit = Hit & Required<Pick<Hit, '_geoLoc'>>;
+declare type GeoHit<THit extends BaseHit = Record<string, any>> = Hit<THit> & Required<Pick<Hit, '_geoloc'>>;
 
 declare type GeoLoc = {
     lat: number;
@@ -1199,9 +1191,9 @@ declare type GeoLoc = {
  */
 declare const geoSearch: GeoSearchWidget;
 
-declare type GeoSearchConnector = Connector<GeoSearchWidgetDescription, GeoSearchConnectorParams>;
+declare type GeoSearchConnector<THit extends BaseHit = Record<string, any>> = Connector<GeoSearchWidgetDescription<THit>, GeoSearchConnectorParams<THit>>;
 
-declare type GeoSearchConnectorParams = {
+declare type GeoSearchConnectorParams<THit extends BaseHit = Record<string, any>> = {
     /**
      * If true, refine will be triggered as you move the map.
      * @default true
@@ -1211,7 +1203,7 @@ declare type GeoSearchConnectorParams = {
      * Function to transform the items passed to the templates.
      * @default items => items
      */
-    transformItems?: TransformItems<GeoHit>;
+    transformItems?: TransformItems<GeoHit<THit>>;
 };
 
 declare type GeoSearchCSSClasses = Partial<{
@@ -1257,7 +1249,7 @@ declare type GeoSearchMarker<TOptions> = {
     };
 };
 
-declare type GeoSearchRenderState = {
+declare type GeoSearchRenderState<THit extends BaseHit = Record<string, any>> = {
     /**
      * Reset the current bounding box refinement.
      */
@@ -1281,7 +1273,7 @@ declare type GeoSearchRenderState = {
     /**
      * The matched hits from Algolia API.
      */
-    items: GeoHit[];
+    items: Array<GeoHit<THit>>;
     /**
      * The current position of the search.
      */
@@ -1321,11 +1313,11 @@ declare type GeoSearchWidget = WidgetFactory<GeoSearchWidgetDescription & {
     $$widgetType: 'ais.geoSearch';
 }, GeoSearchConnectorParams, GeoSearchWidgetParams>;
 
-declare type GeoSearchWidgetDescription = {
+declare type GeoSearchWidgetDescription<THit extends BaseHit = Record<string, any>> = {
     $$type: 'ais.geoSearch';
-    renderState: GeoSearchRenderState;
+    renderState: GeoSearchRenderState<THit>;
     indexRenderState: {
-        geoSearch: WidgetRenderState<GeoSearchRenderState, GeoSearchConnectorParams>;
+        geoSearch: WidgetRenderState<GeoSearchRenderState<THit>, GeoSearchConnectorParams<THit>>;
     };
     indexUiState: {
         geoSearch: {
@@ -4582,17 +4574,6 @@ declare type SearchBoxWidgetParams = {
     queryHook?: (query: string, hook: (value: string) => void) => void;
 };
 
-declare type SearchClient = {
-    search: DefaultSearchClient['search'];
-    searchForFacetValues: DefaultSearchClient['searchForFacetValues'];
-    addAlgoliaAgent?: DefaultSearchClient['addAlgoliaAgent'];
-    initIndex?: (indexName: string) => SearchIndex extends {
-        findAnswers: any;
-    } ? Partial<Pick<SearchIndex, 'findAnswers'>> : SearchIndex;
-};
-
-declare type SearchIndex = ReturnType<DefaultSearchClient['initIndex']>;
-
 declare type SendEvent = (...args: [InsightsEvent] | [string, string, string?]) => void;
 
 declare type SendEventForFacet = BuiltInSendEventForFacet & CustomSendEventForFacet;