Add changeset for autocomplete release

Author: bidoubiwa

.changeset/beige-snails-tan.md

@@ -0,0 +1,5 @@
+---
+"@meilisearch/instant-meilisearch": patch
+---
+
+Export a new type `AlgoliaSearchForFacetValuesResponse`

.changeset/curly-seas-bow.md

@@ -0,0 +1,5 @@
+---
+"@meilisearch/autocomplete-client": minor
+---
+
+Creation of search client compatible with autocomplete.

.github/workflows/meilisearch-prototype-tests.yml

@@ -47,7 +47,7 @@ jobs:
       - name: Setup node
         uses: actions/setup-node@v3
         with:
-          node-version: 16
+          node-version: 18
           cache: yarn
       - name: Install dependencies
         run: yarn

.github/workflows/pre-release-tests.yml

@@ -45,7 +45,7 @@ jobs:
       - name: Setup node
         uses: actions/setup-node@v3
         with:
-          node-version: 16
+          node-version: 18
           cache: yarn
       - name: Install dependencies
         run: yarn

packages/autocomplete-client/README.md

@@ -43,6 +43,8 @@ Since `autocomplete.js` provides the possibility to use a custom `data source`,
 
 For general information on how to use Meilisearch—such as our API reference, tutorials, guides, and in-depth articles—refer to our [main documentation website](https://docs.meilisearch.com/).
 
+For information on how to use the `autocomplete` library refer to its [documentation](https://www.algolia.com/doc/ui-libraries/autocomplete/introduction/what-is-autocomplete/). It provides all the necessery information to set up your autocomplete experience.
+
 ## 🔧 Installation
 
 Use `npm` or `yarn` to install the autocomplete client for Meilisearch.
@@ -70,7 +72,7 @@ The Meilisearch Autocomplete client provides 2 methods:
 
 ## 🎬 Getting started
 
-To make `autocomplete` work with meilisearch, create the `autocompleteSearchClient` and provide it to the `getMeilisearchResults` method as the searchClient.
+To make `autocomplete` work with Meilisearch, create the `autocompleteSearchClient` and provide it to the `getMeilisearchResults` method as the `searchClient`.
 The following code provides a basic working code example.
 
 ```js
@@ -106,7 +108,7 @@ autocomplete({
         },
         templates: {
           item({ item, components, html }) {
-            return html` <div>
+            return html`<div>
               <div>${item.name}</div>
               <div>${item.description}</div>
             </div>`
@@ -138,7 +140,6 @@ const client = meilisearchAutocompleteClient({
     placeholderSearch: false,
   },
 })
-
 ```
 
 ### Placeholder Search
@@ -192,9 +193,7 @@ The other strategy is `all`, where both `hello` and `world` **must** be present
 
 
 ```js
-{
-  matchingStrategy: 'all' // default last
-}
+{ matchingStrategy: 'all' }  // default last
 ```
 
 ### Request Config
@@ -233,11 +232,6 @@ You can use your own HTTP client, for example, with [`axios`](https://github.com
 }
 ```
 
-## More Documentation
-
-- The open-source `autocomplete` library is widely used and well documented in the [Algolia documentation](https://www.algolia.com/doc/ui-libraries/autocomplete/introduction/what-is-autocomplete/). It provides all the necessery information to set up your autocomplete experience.
-- The [Meilisearch documentation](https://docs.meilisearch.com/).
-
 ## 🤖 Compatibility with Meilisearch and Autocomplete
 
 **Supported autocomplete versions**:
@@ -247,12 +241,12 @@ This package only guarantees the compatibility with the [version v1.x.x of Autoc
 **API compatibility with `autocomplete`**
 Some `autocomplete` parameters are not working using the meilisearch autocomplete client.
 
-- The autocomplete [insights] parameters (https://www.algolia.com/doc/ui-libraries/autocomplete/api-reference/autocomplete-js/autocomplete/#param-insights)
+- The autocomplete [insights parameter](https://www.algolia.com/doc/ui-libraries/autocomplete/api-reference/autocomplete-js/autocomplete/#param-insights)
 - The [autocomplete-plugin-algolia-insights](https://www.algolia.com/doc/ui-libraries/autocomplete/api-reference/autocomplete-plugin-algolia-insights/) plugin
 
 **Supported Meilisearch versions**:
 
-This package only guarantees the compatibility with the [version v1.0.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v1.0.0).
+This package guarantees compatibility with [version v1.x of Meilisearch](https://github.com/meilisearch/meilisearch/releases/latest), but some features may not be present. Please check the [issues](https://github.com/meilisearch/instant-meilisearch/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22+label%3Aenhancement) for more info.
 
 **Node / NPM versions**:
 

packages/autocomplete-client/__tests__/test.utils.ts

@@ -1,4 +1,5 @@
 import { meilisearchAutocompleteClient } from '../src'
+import { MeiliSearch } from 'meilisearch'
 
 const dataset = [
   { id: 1, label: 'Hit 1' },
@@ -10,4 +11,10 @@ const searchClient = meilisearchAutocompleteClient({
   url: HOST,
   apiKey: API_KEY,
 })
-export { HOST, API_KEY, searchClient, dataset }
+
+const meilisearchClient = new MeiliSearch({
+  host: 'http://localhost:7700',
+  apiKey: 'masterKey',
+})
+
+export { HOST, API_KEY, searchClient, dataset, meilisearchClient }

packages/autocomplete-client/src/constants/index.ts

@@ -1,2 +1,3 @@
 export const HIGHLIGHT_PRE_TAG = '__aa-highlight__'
 export const HIGHLIGHT_POST_TAG = '__/aa-highlight__'
+export const HITS_PER_PAGE = 5

packages/autocomplete-client/src/requesters/__tests__/getmeilisearchResults.test.ts

@@ -2,7 +2,7 @@ import { getMeilisearchResults } from '../'
 import { searchClient } from '../../../__tests__/test.utils'
 
 describe('getMeilisearchResults', () => {
-  test('returns the description', () => {
+  test('the the fields in the returned description object', () => {
     const description = getMeilisearchResults({
       searchClient,
       queries: [
@@ -35,7 +35,7 @@ describe('getMeilisearchResults', () => {
     })
   })
 
-  test('defaults transformItems to retrieve hits', () => {
+  test('the default transformItems method on the retrieved hits', () => {
     const description = getMeilisearchResults<{ label: string }>({
       searchClient,
       queries: [

packages/autocomplete-client/src/search/__tests__/fetchMeilisearchResults.test.ts

@@ -1,14 +1,18 @@
 import { fetchMeilisearchResults } from '../fetchMeilisearchResults'
-import { searchClient, dataset } from '../../../__tests__/test.utils'
-import { MeiliSearch } from 'meilisearch'
+import {
+  searchClient,
+  dataset,
+  meilisearchClient,
+} from '../../../__tests__/test.utils'
 
 beforeAll(async () => {
-  const client = new MeiliSearch({
-    host: 'http://localhost:7700',
-    apiKey: 'masterKey',
-  })
-  const task = await client.index('testUid').addDocuments(dataset)
-  await client.waitForTask(task.taskUid)
+  await meilisearchClient.deleteIndex('testUid')
+  const task = await meilisearchClient.index('testUid').addDocuments(dataset)
+  await meilisearchClient.waitForTask(task.taskUid)
+})
+
+afterAll(async () => {
+  await meilisearchClient.deleteIndex('testUid')
 })
 
 describe('fetchMeilisearchResults', () => {

packages/autocomplete-client/src/search/fetchMeilisearchResults.ts

@@ -2,7 +2,11 @@ import {
   AlgoliaMultipleQueriesQuery,
   AlgoliaSearchResponse,
 } from '@meilisearch/instant-meilisearch'
-import { HIGHLIGHT_PRE_TAG, HIGHLIGHT_POST_TAG } from '../constants'
+import {
+  HIGHLIGHT_PRE_TAG,
+  HIGHLIGHT_POST_TAG,
+  HITS_PER_PAGE,
+} from '../constants'
 import { SearchClient as MeilisearchSearchClient } from '../types/SearchClient'
 
 interface SearchParams {
@@ -28,7 +32,7 @@ export function fetchMeilisearchResults<TRecord = Record<string, any>>({
         return {
           ...headers,
           params: {
-            hitsPerPage: 5,
+            hitsPerPage: HITS_PER_PAGE,
             highlightPreTag: HIGHLIGHT_PRE_TAG,
             highlightPostTag: HIGHLIGHT_POST_TAG,
             ...params,