Merge #1257

1257: Changes related to the next Meilisearch release (v0.28.0) r=bidoubiwa a=meili-bot

Related to this issue: meilisearch/integration-guides#205

This PR:
- gathers the changes related to the next Meilisearch release (v0.28.0) so that this package is ready when the official release is out.
- should pass the tests against the [latest pre-release of Meilisearch](https://github.com/meilisearch/meilisearch/releases).
- might eventually contain test failures until the Meilisearch v0.28.0 is out.

⚠️ This PR should NOT be merged until the next release of Meilisearch (v0.28.0) is out.

_This PR is auto-generated for the [pre-release week](https://github.com/meilisearch/integration-guides/blob/master/guides/pre-release-week.md) purpose._


Co-authored-by: meili-bot <[email protected]>
Co-authored-by: cvermand <[email protected]>
Co-authored-by: Charlotte Vermandel <[email protected]>

Author: 3 people

.code-samples.meilisearch.yaml

@@ -273,7 +273,7 @@ search_parameter_guide_highlight_tag_1: |-
   })
 search_parameter_guide_matches_1: |-
   client.index('movies').search('winter feast', {
-    matches: true
+    showMatchesPosition: true
   })
 settings_guide_synonyms_1: |-
   client.index('tops').updateSettings({
@@ -497,7 +497,7 @@ faceted_search_filter_1: |-
 faceted_search_facets_distribution_1: |-
   client.index('movies')
     .search('Batman', {
-      facetsDistribution: ['genres']
+      facets: ['genres']
     })
 faceted_search_walkthrough_filter_1: |-
   client.index('movies')
@@ -506,8 +506,6 @@ faceted_search_walkthrough_filter_1: |-
     })
 post_dump_1: |-
   client.createDump()
-get_dump_status_1: |-
-  client.getDumpStatus('20201101-110357260')
 phrase_search_1: |-
   client.index('movies')
     .search('"african american" horror')

.github/scripts/check-release.sh

@@ -2,10 +2,18 @@
 
 # Checking if current tag matches the package version
 current_tag=$(echo $GITHUB_REF | cut -d '/' -f 3 | tr -d ' ',v)
-file_tag=$(grep '"version":' package.json | cut -d ':' -f 2- | tr -d ' ' | tr -d '"' | tr -d ',')
-if [ "$current_tag" != "$file_tag" ]; then
+
+package_json_version=$(grep '"version":' package.json | cut -d ':' -f 2- | tr -d ' ' | tr -d '"' | tr -d ',')
+if [ "$current_tag" != "$package_json_version" ]; then
   echo "Error: the current tag does not match the version in package file(s)."
-  echo "$current_tag vs $file_tag"
+  echo "$current_tag vs $package_json_version"
+  exit 1
+fi
+
+package_version_ts=$(grep "PACKAGE_VERSION =" src/package-version.ts | cut -d "=" -f 2- | tr -d " " | tr -d "'")
+if [ "$current_tag" != "$package_version_ts" ]; then
+  echo "Error: the current tag does not match the version in src/package-version.ts."
+  echo "$current_tag vs $package_version_ts"
   exit 1
 fi
 

CONTRIBUTING.md

@@ -115,12 +115,18 @@ _[Read more about this](https://github.com/meilisearch/integration-guides/blob/m
 
 ⚠️ Before doing anything, make sure you got through the guide about [Releasing an Integration](https://github.com/meilisearch/integration-guides/blob/main/resources/integration-release.md).
 
-Make a PR modifying the file [`package.json`](/package.json) with the right version.
+Make a PR modifying the following files with the right version:
 
+[`package.json`](/package.json):
 ```javascript
 "version": "X.X.X",
 ```
 
+[`src/package-version`](/src/package-version.ts)
+```javascript
+export const PACKAGE_VERSION = 'X.X.X'
+```
+
 Once the changes are merged on `main`, you can publish the current draft release via the [GitHub interface](https://github.com/meilisearch/meilisearch-js/releases): on this page, click on `Edit` (related to the draft release) > update the description (be sure you apply [these recommandations](https://github.com/meilisearch/integration-guides/blob/main/resources/integration-release.md#writting-the-release-description)) > when you are ready, click on `Publish release`.
 
 GitHub Actions will be triggered and push the package to [npm](https://www.npmjs.com/package/meilisearch).

README.md

@@ -192,7 +192,7 @@ Output:
   ],
   "offset": 0,
   "limit": 20,
-  "nbHits": 1,
+  "estimatedTotalHits": 1,
   "processingTimeMs": 1,
   "query": "philoudelphia"
 }
@@ -227,7 +227,7 @@ await index.search(
   ],
   "offset": 0,
   "limit": 20,
-  "nbHits": 1,
+  "estimatedTotalHits": 1,
   "processingTimeMs": 0,
   "query": "wonder"
 }
@@ -270,7 +270,7 @@ await index.search(
   ],
   "offset": 0,
   "limit": 20,
-  "nbHits": 1,
+  "estimatedTotalHits": 1,
   "processingTimeMs": 0,
   "query": "wonder"
 }
@@ -285,7 +285,7 @@ await index.search(
   '',
   {
     filter: ['genres = fantasy'],
-    facetsDistribution: ['genres']
+    facets: ['genres']
   }
 )
 ```
@@ -306,10 +306,10 @@ await index.search(
   ],
   "offset": 0,
   "limit": 20,
-  "nbHits": 2,
+  "estimatedTotalHits": 2,
   "processingTimeMs": 0,
   "query": "",
-  "facetsDistribution": {
+  "facetDistribution": {
     "genres": {
       "Action": 2,
       "Fantasy": 1,
@@ -342,7 +342,7 @@ controller.abort()
 
 ## 🤖 Compatibility with Meilisearch
 
-This package only guarantees the compatibility with the [version v0.27.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.27.0).
+This package only guarantees the compatibility with the [version v0.28.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.28.0).
 
 ## 💡 Learn More
 
@@ -393,7 +393,7 @@ If you want to know more about the development workflow or want to contribute, p
 
 - [Get Documents](https://docs.meilisearch.com/reference/api/documents.html#get-documents):
 
-`index.getDocuments(params: getDocumentsParams): Promise<Document<T>[]>`
+`index.getDocuments(parameters: DocumentsQuery = {}): Promise<DocumentsResults<T>>>`
 
 - [Get one document](https://docs.meilisearch.com/reference/api/documents.html#get-one-document):
 
@@ -413,47 +413,44 @@ If you want to know more about the development workflow or want to contribute, p
 
 ### Tasks <!-- omit in toc -->
 
-- [Get task info using the client](https://docs.meilisearch.com/reference/api/tasks.html#get-all-tasks):
+- [Get all tasks](https://docs.meilisearch.com/reference/api/tasks.html#get-all-tasks)
 
-Task list:
-`client.getTasks(): Promise<Result<Task[]>>`
+  `client.getTasks(parameters: TasksQuery): Promise<TasksResults>`
 
-One task:
-`client.getTask(uid: number): Promise<Task>`
+- [Get one task](https://docs.meilisearch.com/reference/api/tasks.html#get-task)
 
-- [Get task info using the index](https://docs.meilisearch.com/reference/api/tasks.html#get-all-tasks-by-index):
+  `client.getTask(uid: number): Promise<Task>`
 
-Task list:
-`index.getTasks(): Promise<Result<Task[]>>`
+- [Get all tasks of an index](https://docs.meilisearch.com/reference/api/tasks.html#get-all-tasks-by-index)
 
-One task:
-`index.getTask(uid: number): Promise<Task>`
+  `index.getTasks(parameters: TasksQuery): Promise<TasksResults>`
+
+- [Get one task of an index](https://docs.meilisearch.com/reference/api/tasks.html#get-task)
+
+  `index.getTask(uid: number): Promise<Task>`
 
 - Wait for one task:
 
-Using de client:
-`client.waitForTask(uid: number, { timeOutMs?: number, intervalMs?: number }): Promise<Task>`
+  `client.waitForTask(uid: number, { timeOutMs?: number, intervalMs?: number }): Promise<Task>`
 
-Using the index:
-`index.waitForTask(uid: number, { timeOutMs?: number, intervalMs?: number }): Promise<Task>`
+  With an index instance:
+  `index.waitForTask(uid: number, { timeOutMs?: number, intervalMs?: number }): Promise<Task>`
 
 - Wait for multiple tasks:
+  `client.waitForTasks(uids: number[], { timeOutMs?: number, intervalMs?: number }): Promise<Task[]>`
 
-Using the client:
-`client.waitForTasks(uids: number[], { timeOutMs?: number, intervalMs?: number }): Promise<Result<Task[]>>`
-
-Using the index:
-`index.waitForTasks(uids: number[], { timeOutMs?: number, intervalMs?: number }): Promise<Result<Task[]>>`
+  With an index instance:
+  `index.waitForTasks(uids: number[], { timeOutMs?: number, intervalMs?: number }): Promise<Task[]>`
 
 ### Indexes <!-- omit in toc -->
 
-- [Get all indexes in Index instances](https://docs.meilisearch.com/reference/api/indexes.html#list-all-indexes):
+- [Get all indexes as Index instances](https://docs.meilisearch.com/reference/api/indexes.html#list-all-indexes):
 
-`client.getIndexes(): Promise<Index[]>`
+`client.getIndexes(parameters: IndexesQuery): Promise<IndexesResults<Index[]>>`
 
-- [Get raw indexes in JSON response from Meilisearch](https://docs.meilisearch.com/reference/api/indexes.html#list-all-indexes):
+- [Get all indexes](https://docs.meilisearch.com/reference/api/indexes.html#list-all-indexes):
 
-`client.getRawIndexes(): Promise<IndexResponse[]>`
+`client.getRawIndexes(parameters: IndexesQuery): Promise<IndexesResults<IndexObject[]>>`
 
 - [Create a new index](https://docs.meilisearch.com/reference/api/indexes.html#create-an-index):
 
@@ -467,10 +464,10 @@ Using the index:
 `client.getIndex<T>(uid: string): Promise<Index<T>>`
 
 - [Get the raw index JSON response from Meilisearch](https://docs.meilisearch.com/reference/api/indexes.html#get-one-index):
-`client.getRawIndex(uid: string): Promise<IndexResponse>`
+`client.getRawIndex(uid: string): Promise<IndexObject>`
 
 - [Get an object with information about the index](https://docs.meilisearch.com/reference/api/indexes.html#get-one-index):
-`index.getRawInfo(): Promise<IndexResponse>`
+`index.getRawInfo(): Promise<IndexObject>`
 
 - [Update Index](https://docs.meilisearch.com/reference/api/indexes.html#update-an-index):
 
@@ -620,23 +617,23 @@ Using the index object:
 
 - [Get keys](https://docs.meilisearch.com/reference/api/keys.html#get-all-keys):
 
-`client.getKeys(): Promise<Result<Key[]>>`
+`client.getKeys(parameters: KeysQuery): Promise<KeysResults>`
 
 - [Get one key](https://docs.meilisearch.com/reference/api/keys.html#get-one-key):
 
-`client.getKey(key: string): Promise<Key>`
+`client.getKey(keyOrUid: string): Promise<Key>`
 
 - [Create a key](https://docs.meilisearch.com/reference/api/keys.html#create-a-key):
 
-`client.createKey(options: KeyPayload): Promise<Key>`
+`client.createKey(options: KeyCreation): Promise<Key>`
 
 - [Update a key](https://docs.meilisearch.com/reference/api/keys.html#update-a-key):
 
-`client.updateKey(key: string, options: KeyPayload): Promise<Key>`
+`client.updateKey(keyOrUid: string, options: KeyUpdate): Promise<Key>`
 
 - [Delete a key](https://docs.meilisearch.com/reference/api/keys.html#delete-a-key):
 
-`client.deleteKey(key: string): Promise<void>`
+`client.deleteKey(keyOrUid: string): Promise<void>`
 
 ### isHealthy <!-- omit in toc -->
 
@@ -666,11 +663,7 @@ Using the index object:
 
 - [Trigger a dump creation process](https://docs.meilisearch.com/reference/api/dump.html#create-a-dump):
 
-`client.createDump(): Promise<Types.EnqueuedDump>`
-
-- [Get the status of a dump creation process](https://docs.meilisearch.com/reference/api/dump.html#get-dump-status):
-
-`client.getDumpStatus(dumpUid: string): Promise<Types.EnqueuedDump>`
+`client.createDump(): Promise<EnqueuedTask>`
 
 <hr>
 

playgrounds/javascript/src/app.js

@@ -10,8 +10,8 @@ const indexUid = 'movies'
 
 const addDataset = async () => {
   await client.deleteIndex(indexUid)
-  const { uid } = await client.createIndex(indexUid)
-  await client.index(indexUid).waitForTask(uid)
+  const { taskUid } = await client.createIndex(indexUid)
+  await client.index(indexUid).waitForTask(taskUid)
 
   const documents = await client.index(indexUid).getDocuments()
 
@@ -27,9 +27,9 @@ const addDataset = async () => {
     { id: 5, title: 'Moana', genres: ['Fantasy', 'Action'] },
     { id: 6, title: 'Philadelphia', genres: ['Drama'] },
   ]
-  if (documents.length === 0) {
-    const task = await client.index(indexUid).addDocuments(dataset)
-    await client.index(indexUid).waitForTask(task.uid)
+  if (documents.results.length === 0) {
+    const { taskUid } = await client.index(indexUid).addDocuments(dataset)
+    await client.index(indexUid).waitForTask(taskUid)
   }
 }