fix(client): support v5 fully (#6270)

* chore(examples): update search client to v5 * chore: types running with v4 locally, but also v4 and v3 (#6271) * chore: change type * WIP: expand search parameters doesn't work as there still are v4 v5 differences of course * do it correctly * use regular client * not sure if this should stay * WIP * changes rule * fix dependency * change order to make script work * almost all types fixed * improve test * fix(types): accepts client with wrong types will be fixed once algolia/api-clients-automation#3357 is done * tests * chore(helper): compatibility * chore(legacy): correct replacement * don't remove v5 fully * fix errors * safer (or less safe lol) * correct import * fix fake type * v5 only works * tests * script for examples too * script for examples too * chore(answers): bleh get rid of this! * stuff * simplify * ci: add downgrade script for algoliasearch v4 and steps (#6286) * ci: add downgrade script for algoliasearch v4 and steps * test:ci instead * store results * fixes --------- Co-authored-by: Haroen Viaene <hello@haroen.me> Co-authored-by: Aymeric Giraudet <aymeric.giraudet@algolia.com>
algolia · Aug 20, 2024 · c3b5e80 · c3b5e80
1 parent 41b0c96
commit c3b5e80
Show file tree

Hide file tree

Showing 137 changed files with 1,042 additions and 522 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -51,7 +51,10 @@ workflows:
  - unit tests:
  requires:
  - build
- - legacy algoliasearch:
+ - legacy algoliasearch v3:
+ requires:
+ - build
+ - legacy algoliasearch v4:
  requires:
  - build
  - vue v3:
@@ -97,7 +100,8 @@ workflows:
  - lint
  - unit tests
  - examples
- - legacy algoliasearch
+ - legacy algoliasearch v3
+ - legacy algoliasearch v4
  - helper docs
  - e2e tests
  filters:
@@ -202,7 +206,7 @@ jobs:
  name: Type Checking
  command: yarn run type-check
 
- legacy algoliasearch:
+ legacy algoliasearch v3:
  <<: *defaults
  steps:
  - checkout
@@ -221,6 +225,28 @@ jobs:
  name: Type Checking
  command: yarn run type-check:v3
 
+ legacy algoliasearch v4:
+ <<: *defaults
+ resource_class: large
+ steps:
+ - checkout
+ - *attach_workspace
+ - *install_yarn_version
+ - *restore_yarn_cache
+ - *run_yarn_install
+ - run:
+ name: Update dependencies
+ command: |
+ ./scripts/legacy/downgrade-algoliasearch-v4.js
+ - run:
+ name: Unit & Integration tests
+ command: yarn run test:ci
+ - store_test_results:
+ path: junit/jest/
+ - run:
+ name: Type Checking
+ command: yarn run type-check
+
  vue v3:
  <<: *defaults
  steps:

diff --git a/examples/js/calendar-widget/app.js b/examples/js/calendar-widget/app.js
@@ -1,5 +1,5 @@
 /* global moment Calendar $ */
-import algoliasearch from 'algoliasearch/lite';
+import { liteClient as algoliasearch } from 'algoliasearch/lite';
 import instantsearch from 'instantsearch.js';
 import { connectRange } from 'instantsearch.js/es/connectors';
 import { searchBox, hits } from 'instantsearch.js/es/widgets';

diff --git a/examples/js/calendar-widget/package.json b/examples/js/calendar-widget/package.json
@@ -8,7 +8,7 @@
  "website:examples": "BABEL_ENV=parcel parcel build index.html --public-url . --dist-dir=../../../website/examples/js/calendar-widget"
  },
  "dependencies": {
- "algoliasearch": "4.23.2",
+ "algoliasearch": "5.0.0",
  "instantsearch.js": "4.73.4"
  },
  "devDependencies": {

diff --git a/examples/js/e-commerce-umd/package.json b/examples/js/e-commerce-umd/package.json
@@ -9,7 +9,7 @@
  },
  "browserslist": "firefox 68, chrome 78, IE 11",
  "dependencies": {
- "algoliasearch": "4.23.2",
+ "algoliasearch": "5.0.0",
  "instantsearch.js": "4.73.4"
  },
  "devDependencies": {

diff --git a/examples/js/e-commerce-umd/src/search.ts b/examples/js/e-commerce-umd/src/search.ts
@@ -1,4 +1,4 @@
-import algoliasearch from 'algoliasearch/lite';
+import { liteClient as algoliasearch } from 'algoliasearch/lite';
 
 import getRouting from './routing';
 import {

diff --git a/examples/js/e-commerce/package.json b/examples/js/e-commerce/package.json
@@ -9,7 +9,7 @@
  },
  "browserslist": "firefox 68, chrome 78, IE 11",
  "dependencies": {
- "algoliasearch": "4.23.2",
+ "algoliasearch": "5.0.0",
  "instantsearch.js": "4.73.4"
  },
  "devDependencies": {

diff --git a/examples/js/e-commerce/src/search.ts b/examples/js/e-commerce/src/search.ts
@@ -1,4 +1,4 @@
-import algoliasearch from 'algoliasearch/lite';
+import { liteClient as algoliasearch } from 'algoliasearch/lite';
 import instantsearch from 'instantsearch.js';
 
 import getRouting from './routing';

diff --git a/examples/js/getting-started/package.json b/examples/js/getting-started/package.json
@@ -9,7 +9,7 @@
  "lint:fix": "npm run lint -- --fix"
  },
  "dependencies": {
- "algoliasearch": "4.23.2",
+ "algoliasearch": "5.0.0",
  "instantsearch.css": "8.4.0",
  "instantsearch.js": "4.73.4"
  },

diff --git a/examples/js/getting-started/products.html b/examples/js/getting-started/products.html
@@ -35,6 +35,6 @@ <h1 class="header-title">
  <div id="related-products"></div>
  </div>
 
- <script type="module" src="./src/products.js"></script>
+ <script type="module" src="./src/products.ts"></script>
  </body>
 </html>
diff --git a/examples/js/getting-started/src/app.js b/examples/js/getting-started/src/app.js
@@ -1,4 +1,4 @@
-import algoliasearch from 'algoliasearch/lite';
+import { liteClient as algoliasearch } from 'algoliasearch/lite';
 import instantsearch from 'instantsearch.js';
 import { carousel } from 'instantsearch.js/es/templates';
 import {

diff --git a/examples/js/getting-started/src/products.js → examples/js/getting-started/src/products.ts b/examples/js/getting-started/src/products.js → examples/js/getting-started/src/products.ts
@@ -1,4 +1,4 @@
-import algoliasearch from 'algoliasearch/lite';
+import { liteClient as algoliasearch } from 'algoliasearch/lite';
 import instantsearch from 'instantsearch.js';
 import { carousel } from 'instantsearch.js/es/templates';
 import { configure, hits, relatedProducts } from 'instantsearch.js/es/widgets';
@@ -9,6 +9,10 @@ const searchParams = new URLSearchParams(document.location.search);
 
 const pid = searchParams.get('pid');
 
+if (!pid) {
+ throw new Error('No product ID provided');
+}
+
 const searchClient = algoliasearch(
  'latency',
  '6be0576ff61c053d5f9a3225e2a90f76'

diff --git a/examples/js/media/package.json b/examples/js/media/package.json
@@ -8,7 +8,7 @@
  "website:examples": "BABEL_ENV=parcel parcel build index.html --public-url . --dist-dir=../../../website/examples/js/media"
  },
  "dependencies": {
- "algoliasearch": "4.23.2",
+ "algoliasearch": "5.0.0",
  "date-fns": "2.25.0",
  "instantsearch.js": "4.73.4"
  },

diff --git a/examples/js/media/src/search.ts b/examples/js/media/src/search.ts
@@ -1,4 +1,4 @@
-import algoliasearch from 'algoliasearch/lite';
+import { liteClient as algoliasearch } from 'algoliasearch/lite';
 import instantsearch from 'instantsearch.js';
 import { singleIndex } from 'instantsearch.js/es/lib/stateMappings';
 

diff --git a/examples/js/tourism/package.json b/examples/js/tourism/package.json
@@ -8,7 +8,7 @@
  "website:examples": "BABEL_ENV=parcel parcel build index.html --public-url . --dist-dir=../../../website/examples/js/tourism"
  },
  "dependencies": {
- "algoliasearch": "4.23.2",
+ "algoliasearch": "5.0.0",
  "instantsearch.js": "4.73.4"
  },
  "devDependencies": {

diff --git a/examples/js/tourism/search.js b/examples/js/tourism/search.js
@@ -1,4 +1,4 @@
-import algoliasearch from 'algoliasearch/lite';
+import { liteClient as algoliasearch } from 'algoliasearch/lite';
 import instantsearch from 'instantsearch.js';
 import {
  configure,

diff --git a/examples/react/default-theme/package.json b/examples/react/default-theme/package.json
@@ -7,7 +7,7 @@
  "start": "BABEL_ENV=parcel parcel index.html"
  },
  "dependencies": {
- "algoliasearch": "4.23.2",
+ "algoliasearch": "5.0.0",
  "instantsearch.js": "4.73.4",
  "react": "18.2.0",
  "react-dom": "18.2.0",

diff --git a/examples/react/default-theme/src/App.tsx b/examples/react/default-theme/src/App.tsx
@@ -1,4 +1,4 @@
-import algoliasearch from 'algoliasearch/lite';
+import { liteClient as algoliasearch } from 'algoliasearch/lite';
 import { Hit as AlgoliaHit } from 'instantsearch.js';
 import React from 'react';
 import {

diff --git a/examples/react/e-commerce/App.tsx b/examples/react/e-commerce/App.tsx
@@ -1,4 +1,4 @@
-import algoliasearch from 'algoliasearch/lite';
+import { liteClient as algoliasearch } from 'algoliasearch/lite';
 import React, { useRef } from 'react';
 import {
  Configure,

diff --git a/examples/react/e-commerce/package.json b/examples/react/e-commerce/package.json
@@ -9,7 +9,7 @@
  },
  "browserslist": "firefox 68, chrome 78, IE 11",
  "dependencies": {
- "algoliasearch": "4.23.2",
+ "algoliasearch": "5.0.0",
  "instantsearch.js": "4.73.4",
  "react": "18.2.0",
  "react-compound-slider": "3.4.0",

diff --git a/examples/react/getting-started/package.json b/examples/react/getting-started/package.json
@@ -7,7 +7,7 @@
  "start": "BABEL_ENV=parcel parcel index.html products.html --port 3000"
  },
  "dependencies": {
- "algoliasearch": "4.23.2",
+ "algoliasearch": "5.0.0",
  "instantsearch.js": "4.73.4",
  "instantsearch.css": "8.4.0",
  "react": "18.2.0",

diff --git a/examples/react/getting-started/src/App.tsx b/examples/react/getting-started/src/App.tsx
@@ -1,4 +1,4 @@
-import algoliasearch from 'algoliasearch/lite';
+import { liteClient as algoliasearch } from 'algoliasearch/lite';
 import { Hit } from 'instantsearch.js';
 import React from 'react';
 import {

diff --git a/examples/react/getting-started/src/Product.tsx b/examples/react/getting-started/src/Product.tsx
@@ -1,4 +1,4 @@
-import algoliasearch from 'algoliasearch/lite';
+import { liteClient as algoliasearch } from 'algoliasearch/lite';
 import { type Hit } from 'instantsearch.js';
 import React from 'react';
 import {

diff --git a/examples/react/next-app-router/app/Search.tsx b/examples/react/next-app-router/app/Search.tsx
@@ -1,6 +1,6 @@
 'use client';
 
-import algoliasearch from 'algoliasearch/lite';
+import { liteClient as algoliasearch } from 'algoliasearch/lite';
 import { Hit as AlgoliaHit } from 'instantsearch.js';
 import React from 'react';
 import {

diff --git a/examples/react/next-app-router/package.json b/examples/react/next-app-router/package.json
@@ -9,7 +9,7 @@
  "lint": "next lint"
  },
  "dependencies": {
- "algoliasearch": "4.23.2",
+ "algoliasearch": "5.0.0",
  "instantsearch.css": "8.4.0",
  "next": "13.5.1",
  "react": "18.2.0",

diff --git a/examples/react/next-routing/package.json b/examples/react/next-routing/package.json
@@ -9,7 +9,7 @@
  "lint": "next lint"
  },
  "dependencies": {
- "algoliasearch": "4.23.2",
+ "algoliasearch": "5.0.0",
  "instantsearch.css": "8.4.0",
  "next": "13.5.1",
  "react": "18.2.0",

diff --git a/examples/react/next-routing/pages/index.tsx b/examples/react/next-routing/pages/index.tsx
@@ -1,4 +1,4 @@
-import algoliasearch from 'algoliasearch/lite';
+import { liteClient as algoliasearch } from 'algoliasearch/lite';
 import { Hit as AlgoliaHit } from 'instantsearch.js';
 import { GetServerSideProps } from 'next';
 import Head from 'next/head';

diff --git a/examples/react/next-routing/pages/test.tsx b/examples/react/next-routing/pages/test.tsx
@@ -1,5 +1,5 @@
 // This is only to test `onStateChange` does not get called twice
-import algoliasearch from 'algoliasearch/lite';
+import { liteClient as algoliasearch } from 'algoliasearch/lite';
 import { GetServerSideProps } from 'next';
 import Head from 'next/head';
 import Link from 'next/link';

diff --git a/examples/react/next/package.json b/examples/react/next/package.json
@@ -9,7 +9,7 @@
  "lint": "next lint"
  },
  "dependencies": {
- "algoliasearch": "4.23.2",
+ "algoliasearch": "5.0.0",
  "instantsearch.css": "8.4.0",
  "next": "13.5.1",
  "react": "18.2.0",

diff --git a/examples/react/next/pages/index.tsx b/examples/react/next/pages/index.tsx
@@ -1,4 +1,4 @@
-import algoliasearch from 'algoliasearch/lite';
+import { liteClient as algoliasearch } from 'algoliasearch/lite';
 import { Hit as AlgoliaHit } from 'instantsearch.js';
 import { GetServerSideProps } from 'next';
 import Head from 'next/head';

diff --git a/examples/react/react-native/App.tsx b/examples/react/react-native/App.tsx
@@ -1,7 +1,7 @@
 import React, { useRef } from 'react';
 import { FlatList, SafeAreaView, StyleSheet, Text, View } from 'react-native';
 import { StatusBar } from 'expo-status-bar';
-import algoliasearch from 'algoliasearch/lite';
+import { liteClient as algoliasearch } from 'algoliasearch/lite';
 import { InstantSearch } from 'react-instantsearch-core';
 
 import { InfiniteHits } from './src/InfiniteHits';

diff --git a/examples/react/react-native/package.json b/examples/react/react-native/package.json
@@ -11,7 +11,7 @@
  "eject": "expo eject"
  },
  "dependencies": {
- "algoliasearch": "4.23.2",
+ "algoliasearch": "5.0.0",
  "expo": "~44.0.0",
  "expo-status-bar": "~1.2.0",
  "instantsearch.js": "4.73.4",

diff --git a/examples/react/react-native/src/Highlight.tsx b/examples/react/react-native/src/Highlight.tsx
@@ -1,6 +1,6 @@
 import React, { Fragment } from 'react';
 import { StyleSheet, Text } from 'react-native';
-import { Hit as AlgoliaHit } from '@algolia/client-search';
+import { Hit as AlgoliaHit } from 'instantsearch.js';
 import {
  getHighlightedParts,
  getPropertyByPath,
@@ -26,7 +26,7 @@ type HighlightProps<THit> = {
  separator?: string;
 };
 
-export function Highlight<THit extends AlgoliaHit<Record<string, unknown>>>({
+export function Highlight<THit extends AlgoliaHit>({
  hit,
  attribute,
  separator = ', ',

diff --git a/examples/react/react-native/src/InfiniteHits.tsx b/examples/react/react-native/src/InfiniteHits.tsx
@@ -1,6 +1,6 @@
 import React, { forwardRef } from 'react';
 import { StyleSheet, View, FlatList } from 'react-native';
-import { Hit as AlgoliaHit } from '@algolia/client-search';
+import { Hit as AlgoliaHit } from 'instantsearch.js';
 import {
  useInfiniteHits,
  UseInfiniteHitsProps,

diff --git a/examples/react/react-native/types/ProductHit.ts b/examples/react/react-native/types/ProductHit.ts
@@ -1,4 +1,4 @@
-import { Hit as AlgoliaHit } from '@algolia/client-search';
+import { Hit as AlgoliaHit } from 'instantsearch.js';
 
 export type ProductHit = AlgoliaHit<{
  brand: string;

diff --git a/examples/react/ssr/package.json b/examples/react/ssr/package.json
@@ -22,7 +22,7 @@
  "webpack-node-externals": "1.7.2"
  },
  "dependencies": {
- "algoliasearch": "4.23.2",
+ "algoliasearch": "5.0.0",
  "express": "4.17.1",
  "react": "18.2.0",
  "react-dom": "18.2.0",

diff --git a/examples/react/ssr/src/searchClient.js b/examples/react/ssr/src/searchClient.js
@@ -1,4 +1,4 @@
-import algoliasearch from 'algoliasearch/lite';
+import { liteClient as algoliasearch } from 'algoliasearch/lite';
 
 export const searchClient = algoliasearch(
  'latency',

diff --git a/examples/react/ssr/webpack.config.js b/examples/react/ssr/webpack.config.js
@@ -26,7 +26,7 @@ module.exports = [
  rules: [
  {
  test: /\.js$/,
- exclude: /node_modules/,
+ exclude: /node_modules\/(?!(algoliasearch)\/).*/,
  use: [
  {
  loader: 'babel-loader',
@@ -48,7 +48,7 @@ module.exports = [
  rules: [
  {
  test: /\.js$/,
- exclude: /node_modules/,
+ exclude: /node_modules\/(?!(algoliasearch)\/).*/,
  use: [
  {
  loader: 'babel-loader',

diff --git a/examples/vue/default-theme/babel.config.js b/examples/vue/default-theme/babel.config.js
@@ -1,4 +1,5 @@
 module.exports = {
  presets: ['@vue/app'],
+ plugins: ['@babel/plugin-proposal-optional-chaining'],
  sourceType: 'unambiguous',
 };
diff --git a/examples/vue/default-theme/package.json b/examples/vue/default-theme/package.json
@@ -8,7 +8,7 @@
  "website:examples": "NODE_OPTIONS=--openssl-legacy-provider vue-cli-service build --dest ../../../website/examples/vue/default-theme"
  },
  "dependencies": {
- "algoliasearch": "4.23.2",
+ "algoliasearch": "5.0.0",
  "core-js": "2",
  "instantsearch.js": "4.73.4",
  "vue": "2.7.14",

diff --git a/examples/vue/default-theme/src/App.vue b/examples/vue/default-theme/src/App.vue
@@ -123,7 +123,7 @@
 </template>
 
 <script>
-import algoliasearch from 'algoliasearch/lite';
+import { liteClient as algoliasearch } from 'algoliasearch/lite';
 import { history as historyRouter } from 'instantsearch.js/es/lib/routers';
 import { simple as simpleMapping } from 'instantsearch.js/es/lib/stateMappings';
 

diff --git a/examples/vue/default-theme/vue.config.js b/examples/vue/default-theme/vue.config.js
@@ -3,4 +3,5 @@ module.exports = {
  devServer: {
  disableHostCheck: true,
  },
+ transpileDependencies: ['algoliasearch'],
 };
diff --git a/examples/vue/e-commerce/babel.config.js b/examples/vue/e-commerce/babel.config.js
@@ -1,4 +1,5 @@
 module.exports = {
  presets: ['@vue/app'],
+ plugins: ['@babel/plugin-proposal-optional-chaining'],
  sourceType: 'unambiguous',
 };