Skip to content

Commit 4a1ec52

Browse files
millotpslorber
andauthored
chore(algolia): upgrade algoliasearch to v5 (#10672)
Co-authored-by: sebastien <lorber.sebastien@gmail.com>
1 parent 37184e5 commit 4a1ec52

File tree

4 files changed

+171
-184
lines changed

4 files changed

+171
-184
lines changed

packages/docusaurus-theme-search-algolia/package.json

+3-3
Original file line numberDiff line numberDiff line change
@@ -33,16 +33,16 @@
3333
"copy:watch": "node ../../admin/scripts/copyUntypedFiles.js --watch"
3434
},
3535
"dependencies": {
36-
"@docsearch/react": "^3.5.2",
36+
"@docsearch/react": "^3.8.1",
3737
"@docusaurus/core": "3.6.3",
3838
"@docusaurus/logger": "3.6.3",
3939
"@docusaurus/plugin-content-docs": "3.6.3",
4040
"@docusaurus/theme-common": "3.6.3",
4141
"@docusaurus/theme-translations": "3.6.3",
4242
"@docusaurus/utils": "3.6.3",
4343
"@docusaurus/utils-validation": "3.6.3",
44-
"algoliasearch": "^4.18.0",
45-
"algoliasearch-helper": "^3.13.3",
44+
"algoliasearch": "^5.17.1",
45+
"algoliasearch-helper": "^3.22.6",
4646
"clsx": "^2.0.0",
4747
"eta": "^2.2.0",
4848
"fs-extra": "^11.1.1",

packages/docusaurus-theme-search-algolia/src/theme/SearchBar/index.tsx

+10-16
Original file line numberDiff line numberDiff line change
@@ -28,17 +28,16 @@ import {
2828
import Translate from '@docusaurus/Translate';
2929
import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
3030
import translations from '@theme/SearchTranslations';
31-
32-
import type {AutocompleteState} from '@algolia/autocomplete-core';
3331
import type {
32+
InternalDocSearchHit,
3433
DocSearchModal as DocSearchModalType,
3534
DocSearchModalProps,
36-
} from '@docsearch/react';
37-
import type {
38-
InternalDocSearchHit,
3935
StoredDocSearchHit,
40-
} from '@docsearch/react/dist/esm/types';
41-
import type {SearchClient} from 'algoliasearch/lite';
36+
DocSearchTransformClient,
37+
} from '@docsearch/react';
38+
39+
import type {AutocompleteState} from '@algolia/autocomplete-core';
40+
import type {FacetFilters} from 'algoliasearch/lite';
4241

4342
type DocSearchProps = Omit<
4443
DocSearchModalProps,
@@ -80,16 +79,10 @@ function ResultsFooter({state, onClose}: ResultsFooterProps) {
8079
);
8180
}
8281

83-
type FacetFilters = Required<
84-
Required<DocSearchProps>['searchParameters']
85-
>['facetFilters'];
86-
8782
function mergeFacetFilters(f1: FacetFilters, f2: FacetFilters): FacetFilters {
88-
const normalize = (
89-
f: FacetFilters,
90-
): readonly string[] | readonly (string | readonly string[])[] =>
83+
const normalize = (f: FacetFilters): FacetFilters =>
9184
typeof f === 'string' ? [f] : f;
92-
return [...normalize(f1), ...normalize(f2)] as FacetFilters;
85+
return [...normalize(f1), ...normalize(f2)];
9386
}
9487

9588
function DocSearch({
@@ -159,6 +152,7 @@ function DocSearch({
159152
const closeModal = useCallback(() => {
160153
setIsOpen(false);
161154
searchButtonRef.current?.focus();
155+
setInitialQuery(undefined);
162156
}, []);
163157

164158
const handleInput = useCallback(
@@ -210,7 +204,7 @@ function DocSearch({
210204
);
211205

212206
const transformSearchClient = useCallback(
213-
(searchClient: SearchClient) => {
207+
(searchClient: DocSearchTransformClient) => {
214208
searchClient.addAlgoliaAgent(
215209
'docusaurus',
216210
siteMetadata.docusaurusVersion,

packages/docusaurus-theme-search-algolia/src/theme/SearchPage/index.tsx

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ import React, {
1717
import clsx from 'clsx';
1818

1919
import algoliaSearchHelper from 'algoliasearch-helper';
20-
import algoliaSearch from 'algoliasearch/lite';
20+
import {liteClient} from 'algoliasearch/lite';
2121

2222
import ExecutionEnvironment from '@docusaurus/ExecutionEnvironment';
2323
import Head from '@docusaurus/Head';
@@ -225,7 +225,7 @@ function SearchPageContent(): ReactNode {
225225
? ['language', 'docusaurus_tag']
226226
: [];
227227

228-
const algoliaClient = algoliaSearch(appId, apiKey);
228+
const algoliaClient = liteClient(appId, apiKey);
229229
const algoliaHelper = algoliaSearchHelper(algoliaClient, indexName, {
230230
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
231231
// @ts-ignore: why errors happens after upgrading to TS 5.5 ?

0 commit comments

Comments
 (0)