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

examples/js/calendar-widget/app.js

@@ -1,5 +1,5 @@
 /* global moment Calendar $ */
-import { liteClient as algoliasearch } from 'algoliasearch-v5/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';

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-v5": "npm:algoliasearch@5.0.0-beta.8",
+    "algoliasearch": "npm:algoliasearch@5.0.0-beta.9",
     "instantsearch.js": "4.73.0"
   },
   "devDependencies": {

examples/js/e-commerce-umd/package.json

@@ -9,7 +9,7 @@
   },
   "browserslist": "firefox 68, chrome 78, IE 11",
   "dependencies": {
-    "algoliasearch-v5": "npm:algoliasearch@5.0.0-beta.8",
+    "algoliasearch": "npm:algoliasearch@5.0.0-beta.9",
     "instantsearch.js": "4.73.0"
   },
   "devDependencies": {

examples/js/e-commerce-umd/src/search.ts

@@ -1,4 +1,4 @@
-import { liteClient as algoliasearch } from 'algoliasearch-v5/lite';
+import { liteClient as algoliasearch } from 'algoliasearch/lite';
 
 import getRouting from './routing';
 import {

examples/js/e-commerce/package.json

@@ -9,7 +9,7 @@
   },
   "browserslist": "firefox 68, chrome 78, IE 11",
   "dependencies": {
-    "algoliasearch-v5": "npm:algoliasearch@5.0.0-beta.8",
+    "algoliasearch": "npm:algoliasearch@5.0.0-beta.9",
     "instantsearch.js": "4.73.0"
   },
   "devDependencies": {

examples/js/e-commerce/src/search.ts

@@ -1,4 +1,4 @@
-import { liteClient as algoliasearch } from 'algoliasearch-v5/lite';
+import { liteClient as algoliasearch } from 'algoliasearch/lite';
 import instantsearch from 'instantsearch.js';
 
 import getRouting from './routing';

examples/js/getting-started/package.json

@@ -9,7 +9,7 @@
     "lint:fix": "npm run lint -- --fix"
   },
   "dependencies": {
-    "algoliasearch-v5": "npm:algoliasearch@5.0.0-beta.8",
+    "algoliasearch": "npm:algoliasearch@5.0.0-beta.9",
     "instantsearch.js": "4.73.0"
   },
   "devDependencies": {

examples/js/getting-started/products.html

@@ -43,6 +43,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>

examples/js/getting-started/src/app.js

@@ -1,4 +1,4 @@
-import { liteClient as algoliasearch } from 'algoliasearch-v5/lite';
+import { liteClient as algoliasearch } from 'algoliasearch/lite';
 import instantsearch from 'instantsearch.js';
 import {
   configure,

examples/js/getting-started/src/products.js → examples/js/getting-started/src/products.ts

@@ -1,11 +1,15 @@
-import { liteClient as algoliasearch } from 'algoliasearch-v5/lite';
+import { liteClient as algoliasearch } from 'algoliasearch/lite';
 import instantsearch from 'instantsearch.js';
 import { configure, hits, relatedProducts } from 'instantsearch.js/es/widgets';
 
 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'

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-v5": "npm:algoliasearch@5.0.0-beta.8",
+    "algoliasearch": "npm:algoliasearch@5.0.0-beta.9",
     "date-fns": "2.25.0",
     "instantsearch.js": "4.73.0"
   },

examples/js/media/src/search.ts

@@ -1,4 +1,4 @@
-import { liteClient as algoliasearch } from 'algoliasearch-v5/lite';
+import { liteClient as algoliasearch } from 'algoliasearch/lite';
 import instantsearch from 'instantsearch.js';
 import { singleIndex } from 'instantsearch.js/es/lib/stateMappings';
 

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-v5": "npm:algoliasearch@5.0.0-beta.8",
+    "algoliasearch": "npm:algoliasearch@5.0.0-beta.9",
     "instantsearch.js": "4.73.0"
   },
   "devDependencies": {

examples/js/tourism/search.js

@@ -1,4 +1,4 @@
-import { liteClient as algoliasearch } from 'algoliasearch-v5/lite';
+import { liteClient as algoliasearch } from 'algoliasearch/lite';
 import instantsearch from 'instantsearch.js';
 import {
   configure,

examples/react/default-theme/package.json

@@ -7,7 +7,7 @@
     "start": "BABEL_ENV=parcel parcel index.html"
   },
   "dependencies": {
-    "algoliasearch-v5": "npm:algoliasearch@5.0.0-beta.8",
+    "algoliasearch": "npm:algoliasearch@5.0.0-beta.9",
     "instantsearch.js": "4.73.0",
     "react": "18.2.0",
     "react-dom": "18.2.0",

examples/react/default-theme/src/App.tsx

@@ -1,4 +1,4 @@
-import { liteClient as algoliasearch } from 'algoliasearch-v5/lite';
+import { liteClient as algoliasearch } from 'algoliasearch/lite';
 import { Hit as AlgoliaHit } from 'instantsearch.js';
 import React from 'react';
 import {

examples/react/e-commerce/App.tsx

@@ -1,4 +1,4 @@
-import { liteClient as algoliasearch } from 'algoliasearch-v5/lite';
+import { liteClient as algoliasearch } from 'algoliasearch/lite';
 import React, { useRef } from 'react';
 import {
   Configure,

examples/react/e-commerce/package.json

@@ -9,7 +9,7 @@
   },
   "browserslist": "firefox 68, chrome 78, IE 11",
   "dependencies": {
-    "algoliasearch-v5": "npm:algoliasearch@5.0.0-beta.8",
+    "algoliasearch": "npm:algoliasearch@5.0.0-beta.9",
     "instantsearch.js": "4.73.0",
     "react": "18.2.0",
     "react-compound-slider": "3.4.0",

examples/react/getting-started/package.json

@@ -7,7 +7,7 @@
     "start": "BABEL_ENV=parcel parcel index.html products.html --port 3000"
   },
   "dependencies": {
-    "algoliasearch-v5": "npm:algoliasearch@5.0.0-beta.8",
+    "algoliasearch": "npm:algoliasearch@5.0.0-beta.9",
     "instantsearch.js": "4.73.0",
     "react": "18.2.0",
     "react-dom": "18.2.0",

examples/react/getting-started/src/App.tsx

@@ -1,4 +1,4 @@
-import { liteClient as algoliasearch } from 'algoliasearch-v5/lite';
+import { liteClient as algoliasearch } from 'algoliasearch/lite';
 import { Hit } from 'instantsearch.js';
 import React from 'react';
 import {

examples/react/getting-started/src/Product.tsx

@@ -1,4 +1,4 @@
-import { liteClient as algoliasearch } from 'algoliasearch-v5/lite';
+import { liteClient as algoliasearch } from 'algoliasearch/lite';
 import { type Hit } from 'instantsearch.js';
 import React from 'react';
 import {

examples/react/next-app-router/app/Search.tsx

@@ -1,6 +1,6 @@
 'use client';
 
-import { liteClient as algoliasearch } from 'algoliasearch-v5/lite';
+import { liteClient as algoliasearch } from 'algoliasearch/lite';
 import { Hit as AlgoliaHit } from 'instantsearch.js';
 import React from 'react';
 import {

examples/react/next-app-router/package.json

@@ -9,7 +9,7 @@
     "lint": "next lint"
   },
   "dependencies": {
-    "algoliasearch-v5": "npm:algoliasearch@5.0.0-beta.8",
+    "algoliasearch": "npm:algoliasearch@5.0.0-beta.9",
     "instantsearch.css": "8.3.0",
     "next": "13.5.1",
     "react": "18.2.0",

examples/react/next-routing/package.json

@@ -9,7 +9,7 @@
     "lint": "next lint"
   },
   "dependencies": {
-    "algoliasearch-v5": "npm:algoliasearch@5.0.0-beta.8",
+    "algoliasearch": "npm:algoliasearch@5.0.0-beta.9",
     "instantsearch.css": "8.3.0",
     "next": "13.5.1",
     "react": "18.2.0",

examples/react/next-routing/pages/index.tsx

@@ -1,4 +1,4 @@
-import { liteClient as algoliasearch } from 'algoliasearch-v5/lite';
+import { liteClient as algoliasearch } from 'algoliasearch/lite';
 import { Hit as AlgoliaHit } from 'instantsearch.js';
 import { GetServerSideProps } from 'next';
 import Head from 'next/head';

examples/react/next-routing/pages/test.tsx

@@ -1,5 +1,5 @@
 // This is only to test `onStateChange` does not get called twice
-import { liteClient as algoliasearch } from 'algoliasearch-v5/lite';
+import { liteClient as algoliasearch } from 'algoliasearch/lite';
 import { GetServerSideProps } from 'next';
 import Head from 'next/head';
 import Link from 'next/link';

examples/react/next/package.json

@@ -9,7 +9,7 @@
     "lint": "next lint"
   },
   "dependencies": {
-    "algoliasearch-v5": "npm:algoliasearch@5.0.0-beta.8",
+    "algoliasearch": "npm:algoliasearch@5.0.0-beta.9",
     "instantsearch.css": "8.3.0",
     "next": "13.5.1",
     "react": "18.2.0",

examples/react/next/pages/index.tsx

@@ -1,4 +1,4 @@
-import { liteClient as algoliasearch } from 'algoliasearch-v5/lite';
+import { liteClient as algoliasearch } from 'algoliasearch/lite';
 import { Hit as AlgoliaHit } from 'instantsearch.js';
 import { GetServerSideProps } from 'next';
 import Head from 'next/head';

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 { liteClient as algoliasearch } from 'algoliasearch-v5/lite';
+import { liteClient as algoliasearch } from 'algoliasearch/lite';
 import { InstantSearch } from 'react-instantsearch-core';
 
 import { InfiniteHits } from './src/InfiniteHits';

examples/react/react-native/package.json

@@ -11,7 +11,7 @@
     "eject": "expo eject"
   },
   "dependencies": {
-    "algoliasearch-v5": "npm:algoliasearch@5.0.0-beta.8",
+    "algoliasearch": "npm:algoliasearch@5.0.0-beta.9",
     "expo": "~44.0.0",
     "expo-status-bar": "~1.2.0",
     "instantsearch.js": "4.73.0",

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 = ', ',

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,

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;

examples/react/ssr/package.json

@@ -22,7 +22,7 @@
     "webpack-node-externals": "1.7.2"
   },
   "dependencies": {
-    "algoliasearch-v5": "npm:algoliasearch@5.0.0-beta.8",
+    "algoliasearch": "npm:algoliasearch@5.0.0-beta.9",
     "express": "4.17.1",
     "react": "18.2.0",
     "react-dom": "18.2.0",

examples/react/ssr/src/searchClient.js

@@ -1,4 +1,4 @@
-import { liteClient as algoliasearch } from 'algoliasearch-v5/lite';
+import { liteClient as algoliasearch } from 'algoliasearch/lite';
 
 export const searchClient = algoliasearch(
   'latency',

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-v5": "npm:algoliasearch@5.0.0-beta.8",
+    "algoliasearch": "npm:algoliasearch@5.0.0-beta.9",
     "core-js": "2",
     "instantsearch.js": "4.73.0",
     "vue": "2.7.14",

examples/vue/default-theme/src/App.vue

@@ -123,7 +123,7 @@
 </template>
 
 <script>
-import { liteClient as algoliasearch } from 'algoliasearch-v5/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';
 

examples/vue/e-commerce/package.json

@@ -8,7 +8,7 @@
     "website:examples": "NODE_OPTIONS=--openssl-legacy-provider vue-cli-service build --dest ../../../website/examples/vue/e-commerce"
   },
   "dependencies": {
-    "algoliasearch-v5": "npm:algoliasearch@5.0.0-beta.8",
+    "algoliasearch": "npm:algoliasearch@5.0.0-beta.9",
     "core-js": "2",
     "instantsearch.js": "4.73.0",
     "vue": "2.7.14",

examples/vue/e-commerce/src/App.vue

@@ -489,7 +489,7 @@
 </template>
 
 <script>
-import { liteClient as algoliasearch } from 'algoliasearch-v5/lite';
+import { liteClient as algoliasearch } from 'algoliasearch/lite';
 import VueSlider from 'vue-slider-component';
 
 import getRouting from './routing';

examples/vue/getting-started/package.json

@@ -7,7 +7,7 @@
     "build": "NODE_OPTIONS=--openssl-legacy-provider vue-cli-service build"
   },
   "dependencies": {
-    "algoliasearch-v5": "npm:algoliasearch@5.0.0-beta.8",
+    "algoliasearch": "npm:algoliasearch@5.0.0-beta.9",
     "core-js": "2",
     "instantsearch.js": "4.73.0",
     "vue": "2.7.14",

examples/vue/getting-started/src/App.vue

@@ -57,7 +57,7 @@
 </template>
 
 <script>
-import { liteClient as algoliasearch } from 'algoliasearch-v5/lite';
+import { liteClient as algoliasearch } from 'algoliasearch/lite';
 
 export default {
   data() {

examples/vue/media/package.json

@@ -8,7 +8,7 @@
     "website:examples": "NODE_OPTIONS=--openssl-legacy-provider vue-cli-service build --dest ../../../website/examples/vue/media"
   },
   "dependencies": {
-    "algoliasearch-v5": "npm:algoliasearch@5.0.0-beta.8",
+    "algoliasearch": "npm:algoliasearch@5.0.0-beta.9",
     "core-js": "2",
     "instantsearch.js": "4.73.0",
     "vue": "2.7.14",

examples/vue/media/src/App.vue

@@ -112,7 +112,7 @@
 </template>
 
 <script>
-import { liteClient as algoliasearch } from 'algoliasearch-v5/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';
 

examples/vue/nuxt/package.json

@@ -11,7 +11,7 @@
     "generate": "nuxt generate"
   },
   "dependencies": {
-    "algoliasearch-v5": "npm:algoliasearch@5.0.0-beta.8",
+    "algoliasearch": "npm:algoliasearch@5.0.0-beta.9",
     "cross-env": "^5.2.0",
     "css-loader": "^4.3.0",
     "nuxt": "^2.4.5",

examples/vue/nuxt/pages/search.vue

@@ -33,7 +33,7 @@
 </template>
 
 <script>
-import { liteClient as algoliasearch } from 'algoliasearch-v5/lite';
+import { liteClient as algoliasearch } from 'algoliasearch/lite';
 import {
   AisInstantSearchSsr,
   AisIndex,

examples/vue/ssr/package.json

@@ -8,7 +8,7 @@
     "start": "NODE_ENV=production NODE_OPTIONS=--openssl-legacy-provider vue-cli-service ssr:serve --mode production"
   },
   "dependencies": {
-    "algoliasearch-v5": "npm:algoliasearch@5.0.0-beta.8",
+    "algoliasearch": "npm:algoliasearch@5.0.0-beta.9",
     "core-js": "2",
     "instantsearch.css": "8.3.0",
     "qs": "6.9.7",

examples/vue/ssr/src/main.js

@@ -1,5 +1,5 @@
 /* eslint-disable no-nested-ternary */
-import { liteClient as algoliasearch } from 'algoliasearch-v5/lite';
+import { liteClient as algoliasearch } from 'algoliasearch/lite';
 import qs from 'qs';
 import Vue from 'vue';
 import { createServerRootMixin } from 'vue-instantsearch';