@docsearch/react 3.6.2 → 3.7.0

package/README.md

@@ -40,4 +40,4 @@ export default App;
 
 ## Documentation
 
-[Read documentation →](https://docsearch.algolia.com/docs/DocSearch-v3)
+[Read documentation →](https://docsearch.algolia.com/docs/docsearch-v3)

package/dist/esm/index.d.ts

@@ -1,9 +1,9 @@
-import { AutocompleteState, AutocompleteOptions } from '@algolia/autocomplete-core';
-import { SearchOptions } from '@algolia/client-search';
-import { SearchClient } from 'algoliasearch/lite';
+import { BaseItem, AutocompleteState, AutocompleteContext, AutocompleteInsightsApi, AutocompleteOptions } from '@algolia/autocomplete-core';
+import { SearchClient } from 'algoliasearch';
+import { SearchQuery, LiteClient } from 'algoliasearch/lite';
 import React from 'react';
 
-declare type ContentType = 'content' | 'lvl0' | 'lvl1' | 'lvl2' | 'lvl3' | 'lvl4' | 'lvl5' | 'lvl6';
+type ContentType = 'content' | 'lvl0' | 'lvl1' | 'lvl2' | 'lvl3' | 'lvl4' | 'lvl5' | 'lvl6';
 interface DocSearchHitAttributeHighlightResult {
     value: string;
     matchLevel: 'full' | 'none' | 'partial';
@@ -78,13 +78,22 @@ declare type DocSearchHit = {
     __autocomplete_id?: number;
 };
 
-declare type InternalDocSearchHit = DocSearchHit & {
+interface DocSearchContext extends AutocompleteContext {
+    algoliaInsightsPlugin?: {
+        insights: AutocompleteInsightsApi;
+    };
+}
+interface DocSearchState<TItem extends BaseItem> extends AutocompleteState<TItem> {
+    context: DocSearchContext;
+}
+
+type InternalDocSearchHit = DocSearchHit & {
     __docsearch_parent: InternalDocSearchHit | null;
 };
 
-declare type StoredDocSearchHit = Omit<DocSearchHit, '_highlightResult' | '_snippetResult'>;
+type StoredDocSearchHit = Omit<DocSearchHit, '_highlightResult' | '_snippetResult'>;
 
-declare type DocSearchTranslations = Partial<{
+type DocSearchTranslations = Partial<{
     button: ButtonTranslations;
     modal: ModalTranslations;
 }>;
@@ -93,7 +102,7 @@ interface DocSearchProps {
     apiKey: string;
     indexName: string;
     placeholder?: string;
-    searchParameters?: SearchOptions;
+    searchParameters?: SearchQuery;
     maxResultsPerGroup?: number;
     transformItems?: (items: DocSearchHit[]) => DocSearchHit[];
     hitComponent?: (props: {
@@ -103,7 +112,7 @@ interface DocSearchProps {
     resultsFooterComponent?: (props: {
         state: AutocompleteState<InternalDocSearchHit>;
     }) => JSX.Element | null;
-    transformSearchClient?: (searchClient: SearchClient) => SearchClient;
+    transformSearchClient?: <T extends LiteClient | SearchClient>(searchClient: T) => T;
     disableUserPersonalization?: boolean;
     initialQuery?: string;
     navigator?: AutocompleteOptions<InternalDocSearchHit>['navigator'];
@@ -115,16 +124,16 @@ interface DocSearchProps {
 }
 declare function DocSearch(props: DocSearchProps): JSX.Element;
 
-declare type ButtonTranslations = Partial<{
+type ButtonTranslations = Partial<{
     buttonText: string;
     buttonAriaLabel: string;
 }>;
-declare type DocSearchButtonProps = React.ComponentProps<'button'> & {
+type DocSearchButtonProps = React.ComponentProps<'button'> & {
     translations?: ButtonTranslations;
 };
-declare const DocSearchButton: React.ForwardRefExoticComponent<Pick<DocSearchButtonProps, "translations" | "key" | keyof React.ButtonHTMLAttributes<HTMLButtonElement>> & React.RefAttributes<HTMLButtonElement>>;
+declare const DocSearchButton: React.ForwardRefExoticComponent<Omit<DocSearchButtonProps, "ref"> & React.RefAttributes<HTMLButtonElement>>;
 
-declare type FooterTranslations = Partial<{
+type FooterTranslations = Partial<{
     selectText: string;
     selectKeyAriaLabel: string;
     navigateText: string;
@@ -135,19 +144,19 @@ declare type FooterTranslations = Partial<{
     searchByText: string;
 }>;
 
-declare type ErrorScreenTranslations = Partial<{
+type ErrorScreenTranslations = Partial<{
     titleText: string;
     helpText: string;
 }>;
 
-declare type NoResultsScreenTranslations = Partial<{
+type NoResultsScreenTranslations = Partial<{
     noResultsText: string;
     suggestedQueryText: string;
     reportMissingResultsText: string;
     reportMissingResultsLinkText: string;
 }>;
 
-declare type StartScreenTranslations = Partial<{
+type StartScreenTranslations = Partial<{
     recentSearchesTitle: string;
     noRecentSearchesText: string;
     saveRecentSearchButtonTitle: string;
@@ -156,13 +165,13 @@ declare type StartScreenTranslations = Partial<{
     removeFavoriteSearchButtonTitle: string;
 }>;
 
-declare type ScreenStateTranslations = Partial<{
+type ScreenStateTranslations = Partial<{
     errorScreen: ErrorScreenTranslations;
     startScreen: StartScreenTranslations;
     noResultsScreen: NoResultsScreenTranslations;
 }>;
 
-declare type SearchBoxTranslations = Partial<{
+type SearchBoxTranslations = Partial<{
     resetButtonTitle: string;
     resetButtonAriaLabel: string;
     cancelButtonText: string;
@@ -170,11 +179,11 @@ declare type SearchBoxTranslations = Partial<{
     searchInputLabel: string;
 }>;
 
-declare type ModalTranslations = Partial<{
+type ModalTranslations = Partial<{
     searchBox: SearchBoxTranslations;
     footer: FooterTranslations;
 }> & ScreenStateTranslations;
-declare type DocSearchModalProps = DocSearchProps & {
+type DocSearchModalProps = DocSearchProps & {
     initialScrollY: number;
     onClose?: () => void;
     translations?: ModalTranslations;
@@ -190,6 +199,6 @@ interface UseDocSearchKeyboardEventsProps {
 }
 declare function useDocSearchKeyboardEvents({ isOpen, onOpen, onClose, onInput, searchButtonRef, }: UseDocSearchKeyboardEventsProps): void;
 
-declare const version = "3.6.2";
+declare const version = "3.7.0";
 
-export { type ButtonTranslations, DocSearch, DocSearchButton, type DocSearchButtonProps, DocSearchModal, type DocSearchModalProps, type DocSearchProps, type DocSearchTranslations, type ModalTranslations, type UseDocSearchKeyboardEventsProps, useDocSearchKeyboardEvents, version };
+export { type ButtonTranslations, DocSearch, DocSearchButton, type DocSearchButtonProps, type DocSearchHit, DocSearchModal, type DocSearchModalProps, type DocSearchProps, type DocSearchState, type DocSearchTranslations, type InternalDocSearchHit, type ModalTranslations, type StoredDocSearchHit, type UseDocSearchKeyboardEventsProps, useDocSearchKeyboardEvents, version };