Wrap get indexes routes in results object v0.28 (#1261)

* Update tasks API

* Add additional tests on index tasks routes

* Update readme api references

* Make task typs an enum

* Update wait for tasks tests

* Update getTasks filter to arrays

* Fix taskUid parameter naming in waitForTask

* Make task tests more relevant

* Update the tests impacted by the task api changes

* Keep task destructing in tests

* Fix linting

* Wrap get indexes routes in results object

README.md

@@ -445,13 +445,13 @@ If you want to know more about the development workflow or want to contribute, p
 
 ### 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(): Promise<Result<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(): Promise<Result<IndexResponse[]>>`
 
 - [Create a new index](https://docs.meilisearch.com/reference/api/indexes.html#create-an-index):
 

src/clients/client.ts

@@ -86,20 +86,22 @@ class Client {
    * Get all the indexes as Index instances.
    * @memberof MeiliSearch
    * @method getIndexes
-   * @returns {Promise<Index[]>} Promise returning array of raw index information
+   *
+   * @returns {Promise<Result<Index[]>>} Promise returning array of raw index information
    */
-  async getIndexes(): Promise<Index[]> {
-    const { results } = await this.getRawIndexes()
-    const indexes: Index[] = results.map(
+  async getIndexes(): Promise<Result<Index[]>> {
+    const rawIndexes = await this.getRawIndexes()
+    const indexes: Index[] = rawIndexes.results.map(
       (index) => new Index(this.config, index.uid, index.primaryKey)
     )
-    return indexes
+    return { ...rawIndexes, results: indexes }
   }
 
   /**
    * Get all the indexes in their raw value (no Index instances).
    * @memberof MeiliSearch
    * @method getRawIndexes
+   *
    * @returns {Promise<Result<IndexResponse[]>>} Promise returning array of raw index information
    */
   async getRawIndexes(): Promise<Result<IndexResponse[]>> {

src/indexes.ts

@@ -204,7 +204,7 @@ class Index<T = Record<string, any>> {
    */
   async update(data: IndexOptions): Promise<EnqueuedTask> {
     const url = `indexes/${this.uid}`
-    return await this.httpRequest.put(url, data)
+    return await this.httpRequest.patch(url, data)
   }
 
   /**

src/types/types.ts

@@ -29,7 +29,6 @@ export type IndexOptions = {
 
 export type IndexResponse = {
   uid: string
-  name?: string
   primaryKey?: string
   createdAt: Date
   updatedAt: Date

tests/client.test.ts

@@ -1,11 +1,4 @@
-import {
-  IndexResponse,
-  ErrorStatusCode,
-  Health,
-  Version,
-  Stats,
-  TaskStatus,
-} from '../src'
+import { ErrorStatusCode, Health, Version, Stats } from '../src'
 import {
   clearAllIndexes,
   getKey,
@@ -178,9 +171,10 @@ describe.each([{ permission: 'Master' }, { permission: 'Private' }])(
 
       const task = await client.createIndex('test')
       await client.waitForTask(task.taskUid)
-      const indexes = await client.getIndexes()
 
-      expect(indexes.length).toBe(1)
+      const { results } = await client.getIndexes()
+
+      expect(results.length).toBe(1)
     })
 
     describe('Test on indexes methods', () => {
@@ -232,8 +226,8 @@ describe.each([{ permission: 'Master' }, { permission: 'Private' }])(
         const { taskUid } = await client.createIndex(indexPk.uid)
         await client.waitForTask(taskUid)
 
-        const response: IndexResponse[] = await client.getRawIndexes()
-        const indexes = response.map((index) => index.uid)
+        const { results } = await client.getRawIndexes()
+        const indexes = results.map((index) => index.uid)
         expect(indexes).toEqual(expect.arrayContaining([indexPk.uid]))
         expect(indexes.length).toEqual(1)
       })
@@ -296,10 +290,10 @@ describe.each([{ permission: 'Master' }, { permission: 'Private' }])(
         await client.waitForTask(createTask)
 
         const { taskUid: deleteTask } = await client.deleteIndex(indexNoPk.uid)
-        const task = await client.waitForTask(deleteTask)
+        await client.waitForTask(deleteTask)
+        const { results } = await client.getIndexes()
 
-        expect(task.status).toBe(TaskStatus.TASK_SUCCEEDED)
-        await expect(client.getIndexes()).resolves.toHaveLength(0)
+        expect(results).toHaveLength(0)
       })
 
       test(`${permission} key: create index with already existing uid should fail`, async () => {

tests/index.test.ts

@@ -79,10 +79,10 @@ describe.each([{ permission: 'Master' }, { permission: 'Private' }])(
       const { taskUid } = await client.createIndex(indexPk.uid)
       await client.waitForTask(taskUid)
 
-      const response = await client.getRawIndexes()
+      const { results } = await client.getRawIndexes()
 
-      expect(response.length).toEqual(1)
-      expect(response[0].uid).toEqual(indexPk.uid)
+      expect(results.length).toEqual(1)
+      expect(results[0].uid).toEqual(indexPk.uid)
     })
 
     test(`${permission} key: Get index that does not exist`, async () => {
@@ -280,11 +280,13 @@ describe.each([{ permission: 'Master' }, { permission: 'Private' }])(
     test(`${permission} key: delete index`, async () => {
       const client = await getClient(permission)
       const { taskUid: createTask } = await client.createIndex(indexNoPk.uid)
-      const { taskUid: updateTask } = await client.index(indexNoPk.uid).delete()
+      const { taskUid: deleteTask } = await client.index(indexNoPk.uid).delete()
       await client.waitForTask(createTask)
-      await client.waitForTask(updateTask)
+      await client.waitForTask(deleteTask)
+
+      const { results } = await client.getIndexes()
 
-      await expect(client.getIndexes()).resolves.toHaveLength(0)
+      expect(results).toHaveLength(0)
     })
 
     test(`${permission} key: delete index using client`, async () => {
@@ -293,7 +295,9 @@ describe.each([{ permission: 'Master' }, { permission: 'Private' }])(
       await client.createIndex(indexPk.uid)
       await client.waitForTask(taskUid)
 
-      await expect(client.getIndexes()).resolves.toHaveLength(0)
+      const { results } = await client.getIndexes()
+
+      expect(results).toHaveLength(0)
     })
 
     test(`${permission} key: fetch deleted index should fail`, async () => {

tests/utils/meilisearch-test-utils.ts

@@ -89,8 +89,6 @@ const clearAllIndexes = async (config: Config): Promise<void> => {
   }
 
   await client.waitForTasks(taskIds)
-
-  await expect(client.getIndexes()).resolves.toHaveLength(0)
 }
 
 async function waitForDumpProcessing(