fix(algolia): upgrade algoliasearch to v5

Author: millotp

.yarn/versions/58dc2ade.yml

@@ -0,0 +1,23 @@
+releases:
+  "@yarnpkg/cli": patch
+  "@yarnpkg/plugin-interactive-tools": minor
+  "@yarnpkg/plugin-typescript": minor
+
+declined:
+  - "@yarnpkg/plugin-compat"
+  - "@yarnpkg/plugin-constraints"
+  - "@yarnpkg/plugin-dlx"
+  - "@yarnpkg/plugin-essentials"
+  - "@yarnpkg/plugin-init"
+  - "@yarnpkg/plugin-nm"
+  - "@yarnpkg/plugin-npm-cli"
+  - "@yarnpkg/plugin-pack"
+  - "@yarnpkg/plugin-patch"
+  - "@yarnpkg/plugin-pnp"
+  - "@yarnpkg/plugin-pnpm"
+  - "@yarnpkg/plugin-stage"
+  - "@yarnpkg/plugin-version"
+  - "@yarnpkg/plugin-workspace-tools"
+  - "@yarnpkg/builder"
+  - "@yarnpkg/core"
+  - "@yarnpkg/doctor"

packages/docusaurus/package.json

@@ -10,12 +10,12 @@
   },
   "dependencies": {
     "@codesandbox/sandpack-react": "^1.15.0",
-    "@docusaurus/core": "^3.4.0",
-    "@docusaurus/mdx-loader": "^3.4.0",
-    "@docusaurus/plugin-content-docs": "^3.4.0",
-    "@docusaurus/preset-classic": "^3.4.0",
-    "@docusaurus/theme-classic": "^3.4.0",
-    "@docusaurus/theme-common": "^3.4.0",
+    "@docusaurus/core": "^3.7.0",
+    "@docusaurus/mdx-loader": "^3.7.0",
+    "@docusaurus/plugin-content-docs": "^3.7.0",
+    "@docusaurus/preset-classic": "^3.7.0",
+    "@docusaurus/theme-classic": "^3.7.0",
+    "@docusaurus/theme-common": "^3.7.0",
     "@fontsource/pt-sans": "^5.0.5",
     "@mdx-js/react": "^3.0.0",
     "@monaco-editor/react": "^4.4.6",
@@ -30,7 +30,7 @@
     "@yarnpkg/pnpify": "workspace:^",
     "@yarnpkg/sdks": "workspace:^",
     "@yarnpkg/shell": "workspace:^",
-    "algoliasearch": "^4.14.2",
+    "algoliasearch": "^5.19.0",
     "ansi-to-html": "^0.7.2",
     "clsx": "^1.2.1",
     "docusaurus-plugin-typedoc-api": "patch:docusaurus-plugin-typedoc-api@npm%3A4.2.0#~/.yarn/patches/docusaurus-plugin-typedoc-api-npm-4.2.0-fb78ec678c.patch",
@@ -52,8 +52,7 @@
     "prism-react-renderer": "^2.3.1",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
-    "react-instantsearch-dom": "^6.36.0",
-    "react-instantsearch-hooks-web": "^6.36.0",
+    "react-instantsearch": "^7.15.1",
     "react-json-doc": "^2.3.4",
     "react-loading-skeleton": "^3.3.1",
     "react-modal": "^3.16.1",
@@ -79,8 +78,8 @@
   },
   "devDependencies": {
     "@docusaurus/module-type-aliases": "^3.4.0",
-    "@docusaurus/tsconfig": "^3.4.0",
-    "@docusaurus/types": "^3.4.0",
+    "@docusaurus/tsconfig": "^3.7.0",
+    "@docusaurus/types": "^3.7.0",
     "@types/dompurify": "^3",
     "@types/git-url-parse": "^9.0.0",
     "@types/lodash": "^4.14.136",
@@ -89,7 +88,6 @@
     "@types/mdast": "^4.0.3",
     "@types/node": "^18.19.15",
     "@types/react": "^18.2.54",
-    "@types/react-instantsearch-dom": "^6",
     "@types/react-modal": "^3",
     "@types/react-virtualized": "^9",
     "@types/react-window": "^1",

packages/docusaurus/src/lib/searchClient.ts

@@ -1,4 +1,4 @@
-import algoliasearch from 'algoliasearch/lite';
+import {liteClient as algoliasearch} from 'algoliasearch/lite';
 
 // Note that the appId and appKey are specific to Yarn's website - please
 // don't use them anywhere else without asking Algolia's permission

packages/docusaurus/src/pages/search.tsx

@@ -4,7 +4,7 @@ import useDocusaurusContext                                       from '@docusau
 import {CodeIcon, FileDirectoryIcon}                              from '@primer/octicons-react';
 import Layout                                                     from '@theme/Layout';
 import clsx                                                       from 'clsx';
-import {InstantSearch, useHits, useSearchBox}                     from 'react-instantsearch-hooks-web';
+import {InstantSearch, useHits, useSearchBox}                     from 'react-instantsearch';
 import Skeleton                                                   from 'react-loading-skeleton';
 import React, {useCallback, useEffect, useMemo, useRef, useState} from 'react';
 
@@ -61,9 +61,7 @@ function useHitsWithDefaults(query: string): Array<any> {
   const [defaults, setDefaults] = useState<Array<any> | null>(null);
 
   useEffect(() => {
-    searchClient.customRequest({method: `POST`, path: `/1/indexes/*/objects`}, {
-      data: {requests: defaultRequests},
-    }).then(({results}: any) => {
+    searchClient.getObjects({requests: defaultRequests}).then(({results}: any) => {
       setDefaults(results);
     });
   }, []);

packages/plugin-interactive-tools/package.json

@@ -9,7 +9,7 @@
   },
   "dependencies": {
     "@yarnpkg/libui": "workspace:^",
-    "algoliasearch": "^4.2.0",
+    "algoliasearch": "^5.19.0",
     "clipanion": "^4.0.0-rc.2",
     "diff": "^5.1.0",
     "ink": "^3.2.0",

packages/plugin-interactive-tools/sources/algolia.ts

@@ -1,14 +1,12 @@
-import algoliasearch from 'algoliasearch';
+import {algoliasearch} from 'algoliasearch';
 
 const algolia = {
   appId: `OFCNCOG2CU`,
   apiKey: `6fe4476ee5a1832882e326b506d14126`,
   indexName: `npm-search`,
 };
 
-const client = algoliasearch(algolia.appId, algolia.apiKey).initIndex(
-  algolia.indexName,
-);
+const client = algoliasearch(algolia.appId, algolia.apiKey);
 
 export interface AlgoliaPackage {
   objectID: string;
@@ -34,9 +32,10 @@ export const search = async (
   query: string,
   page: number = 0,
 ) => {
-  const res = await client.search<AlgoliaPackage>(
-    query,
-    {
+  const res = await client.searchSingleIndex<AlgoliaPackage>({
+    indexName: algolia.indexName,
+    searchParams: {
+      query,
       analyticsTags: [`yarn-plugin-interactive-tools`],
       attributesToRetrieve: [
         `name`,
@@ -47,7 +46,8 @@ export const search = async (
       ],
       page,
       hitsPerPage: 10,
-    });
+    },
+  });
 
   return res;
 };

packages/plugin-typescript/package.json

@@ -10,7 +10,7 @@
   "dependencies": {
     "@yarnpkg/fslib": "workspace:^",
     "@yarnpkg/plugin-pack": "workspace:^",
-    "algoliasearch": "^4.2.0",
+    "algoliasearch": "^5.19.0",
     "semver": "^7.1.2",
     "tslib": "^2.4.0"
   },
@@ -20,7 +20,7 @@
     "@yarnpkg/plugin-essentials": "workspace:^"
   },
   "devDependencies": {
-    "@algolia/requester-common": "4.0.0-beta.14",
+    "@algolia/client-common": "^5.19.0",
     "@types/semver": "^7.1.0",
     "@yarnpkg/builder": "workspace:^",
     "@yarnpkg/cli": "workspace:^",

packages/plugin-typescript/sources/typescriptUtils.ts

@@ -1,7 +1,7 @@
-import {Request, Requester, Response} from '@algolia/requester-common';
-import {Configuration, Descriptor}    from '@yarnpkg/core';
-import {httpUtils, structUtils}       from '@yarnpkg/core';
-import algoliasearch                  from 'algoliasearch';
+import type {Request, Requester, Response} from '@algolia/client-common';
+import {Configuration, Descriptor}         from '@yarnpkg/core';
+import {httpUtils, structUtils}            from '@yarnpkg/core';
+import {algoliasearch}                     from 'algoliasearch';
 
 // Note that the appId and appKey are specific to Yarn's plugin-typescript - please
 // don't use them anywhere else without asking Algolia's permission
@@ -20,10 +20,9 @@ export const hasDefinitelyTyped = async (
 ) => {
   const stringifiedIdent = structUtils.stringifyIdent(descriptor);
   const algoliaClient = createAlgoliaClient(configuration);
-  const index = algoliaClient.initIndex(`npm-search`);
 
   try {
-    const packageInfo = await index.getObject<AlgoliaObj>(stringifiedIdent, {attributesToRetrieve: [`types`]});
+    const packageInfo = await algoliaClient.getObject({indexName: `npm-search`, objectID: stringifiedIdent, attributesToRetrieve: [`types`]}) as AlgoliaObj;
 
     return packageInfo.types?.ts === `definitely-typed`;
   } catch (_e) {