Replace keys typing (#1126)

* Replace keys types

* Remove comment

Author: bidoubiwa

README.md

@@ -419,7 +419,7 @@ If you want to know more about the development workflow or want to contribute, p
 
 - [Get all updates info](https://docs.meilisearch.com/reference/api/updates.html#get-all-update-status):
 
-`index.getTasks(): Promise<Tasks>`
+`index.getTasks(): Promise<Result<Task[]>>`
 
 - Wait for one task:
 
@@ -432,10 +432,10 @@ Using de index:
 - Wait for multiple tasks:
 
 Using de client:
-`client.waitForTasks(uids: number[], { timeOutMs?: number, intervalMs?: number }): Promise<Tasks>`
+`client.waitForTasks(uids: number[], { timeOutMs?: number, intervalMs?: number }): Promise<Result<Task[]>>`
 
 Using de index:
-`index.waitForTasks(uids: number[], { timeOutMs?: number, intervalMs?: number }): Promise<Tasks>`
+`index.waitForTasks(uids: number[], { timeOutMs?: number, intervalMs?: number }): Promise<Result<Task[]>>`
 
 ### Indexes <!-- omit in toc -->
 

src/lib/indexes.ts

@@ -12,7 +12,6 @@ import { MeiliSearchError } from '../errors'
 import {
   Config,
   Task,
-  Tasks,
   SearchResponse,
   SearchParams,
   Filter,
@@ -34,6 +33,7 @@ import {
   SortableAttributes,
   SearchableAttributes,
   DisplayedAttributes,
+  Result,
 } from '../types'
 import { removeUndefinedFromObject } from './utils'
 import { HttpRequests } from './http-requests'
@@ -230,9 +230,9 @@ class Index<T = Record<string, any>> {
    * @memberof Indexes
    * @method getTasks
    *
-   * @returns {Promise<Tasks>} - Promise containing all tasks
+   * @returns {Promise<Result<Task[]>>} - Promise containing all tasks
    */
-  async getTasks(): Promise<Tasks> {
+  async getTasks(): Promise<Result<Task[]>> {
     return await this.tasks.getIndexTasks(this.uid)
   }
 
@@ -257,15 +257,15 @@ class Index<T = Record<string, any>> {
    * @param {number[]} taskIds - Tasks identifier
    * @param {WaitOptions} waitOptions - Options on timeout and interval
    *
-   * @returns {Promise<Tasks>} - Promise containing an array of tasks
+   * @returns {Promise<Result<Task[]>>} - Promise containing an array of tasks
    */
   async waitForTasks(
     taskIds: number[],
     {
       timeOutMs = 5000,
       intervalMs = 50,
     }: { timeOutMs?: number; intervalMs?: number } = {}
-  ): Promise<Tasks> {
+  ): Promise<Result<Task[]>> {
     return await this.tasks.waitForClientTasks(taskIds, {
       timeOutMs,
       intervalMs,

src/lib/meilisearch.ts

@@ -21,9 +21,7 @@ import {
   EnqueuedDump,
   ErrorStatusCode,
   Task,
-  Tasks,
-  // FIXME: Should be used in GET /keys
-  // Result,
+  Result,
 } from '../types'
 import { HttpRequests } from './http-requests'
 import { addProtocolIfNotPresent } from './utils'
@@ -164,9 +162,9 @@ class MeiliSearch {
    * Get the list of all client tasks
    * @memberof MeiliSearch
    * @method getTasks
-   * @returns {Promise<Tasks>} - Promise returning all tasks
+   * @returns {Promise<Result<Task[]>>} - Promise returning all tasks
    */
-  async getTasks(): Promise<Tasks> {
+  async getTasks(): Promise<Result<Task[]>> {
     return await this.tasks.getClientTasks()
   }
 
@@ -188,15 +186,15 @@ class MeiliSearch {
    * @param {number[]} taskIds - Tasks identifier
    * @param {WaitOptions} waitOptions - Options on timeout and interval
    *
-   * @returns {Promise<Tasks>} - Promise returning an array of tasks
+   * @returns {Promise<Result<Task[]>>} - Promise returning an array of tasks
    */
   async waitForTasks(
     taskIds: number[],
     {
       timeOutMs = 5000,
       intervalMs = 50,
     }: { timeOutMs?: number; intervalMs?: number } = {}
-  ): Promise<Tasks> {
+  ): Promise<Result<Task[]>> {
     return await this.tasks.waitForClientTasks(taskIds, {
       timeOutMs,
       intervalMs,

src/lib/task.ts

@@ -1,5 +1,5 @@
 import { MeiliSearchTimeOutError } from '../errors'
-import { Config, Task, Tasks, WaitOptions, TaskStatus } from '../types'
+import { Config, Task, WaitOptions, TaskStatus, Result } from '../types'
 import { HttpRequests } from './http-requests'
 import { sleep } from './utils'
 
@@ -15,19 +15,19 @@ class TaskClient {
     return await this.httpRequest.get<Task>(url)
   }
 
-  async getClientTasks(): Promise<Tasks> {
+  async getClientTasks(): Promise<Result<Task[]>> {
     const url = `tasks`
-    return await this.httpRequest.get<Tasks>(url)
+    return await this.httpRequest.get<Result<Task[]>>(url)
   }
 
   async getIndexTask(indexUid: string | number, taskId: number): Promise<Task> {
     const url = `indexes/${indexUid}/tasks/${taskId}`
     return await this.httpRequest.get<Task>(url)
   }
 
-  async getIndexTasks(indexUid: string | number): Promise<Tasks> {
+  async getIndexTasks(indexUid: string | number): Promise<Result<Task[]>> {
     const url = `indexes/${indexUid}/tasks`
-    return await this.httpRequest.get<Tasks>(url)
+    return await this.httpRequest.get<Result<Task[]>>(url)
   }
 
   /**
@@ -62,12 +62,12 @@ class TaskClient {
    *
    * @param {number} taskIds Tasks identifier list
    * @param {WaitOptions} options Wait options
-   * @returns {Promise<Tasks>} Promise returning a list of tasks after they have been processed
+   * @returns {Promise<Result<Task[]>>} Promise returning a list of tasks after they have been processed
    */
   async waitForClientTasks(
     taskIds: number[],
     { timeOutMs = 5000, intervalMs = 50 }: WaitOptions = {}
-  ): Promise<Tasks> {
+  ): Promise<Result<Task[]>> {
     const tasks: Task[] = []
     for (const taskId of taskIds) {
       const task = await this.waitForClientTask(taskId, {

tests/keys_tests.ts

@@ -17,7 +17,6 @@ describe.each([{ permission: 'Master' }])('Test on keys', ({ permission }) => {
   test(`${permission} key: get keys`, async () => {
     const client = await getClient(permission)
     const keys = await client.getKeys()
-    // FIXME: should be inside Result object
 
     const defaultKey = keys.find((key: Key) =>
       key.description.startsWith('Default Search API')