Update result of getKeys route (#1132)

* Update result of getKeys route

* Update different headers in tests

Author: bidoubiwa

README.md

@@ -597,7 +597,7 @@ Using the index object:
 
 - [Get keys](https://docs.meilisearch.com/reference/api/keys.html#get-all-keys):
 
-`client.getKeys(): Promise<Keys>`
+`client.getKeys(): Promise<Result<Key[]>>`
 
 - [Get one key](https://docs.meilisearch.com/reference/api/keys.html#get-one-key):
 

src/lib/meilisearch.ts

@@ -234,10 +234,9 @@ class MeiliSearch {
    * @method getKeys
    * @returns {Promise<Keys>} Promise returning an object with keys
    */
-  // FIXME: should be Result<Key[]>>
-  async getKeys(): Promise<Key[]> {
+  async getKeys(): Promise<Result<Key[]>> {
     const url = `keys`
-    return await this.httpRequest.get<Key[]>(url)
+    return await this.httpRequest.get<Result<Key[]>>(url)
   }
 
   /**

tests/env/express/public/headers.html

@@ -16,15 +16,16 @@
 <script src="./meilisearch.umd.js"></script>
 <script>
   ; (async () => {
-
+    const client = new MeiliSearch({ host: "http://localhost:7700", apiKey: "masterKey" })
+    const UID = "headers"
     const errorDiv = document.createElement("div");
     errorDiv.setAttribute("id", "error");
 
     let error = 'NO ERRORS'
     try {
       const task = await client.createIndex(UID)
       await client.waitForTask(task.uid)
-      await fetch('http://localhost:7700/indexes/movies/documents', {
+      await fetch(`http://localhost:7700/indexes/${UID}/documents`, {
         method: 'POST',
         headers: {
           Authorization: `Bearer masterKey`,

tests/keys_tests.ts

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

tests/meilisearch-test-utils.ts

@@ -1,6 +1,5 @@
 import { MeiliSearch, MeiliSearchTimeOutError, Index, sleep } from '../src/'
 import { Config, IndexResponse, EnqueuedDump } from '../src/types'
-import 'cross-fetch/polyfill'
 
 // testing
 const MASTER_KEY = 'masterKey'
@@ -28,24 +27,20 @@ async function getKey(permission: string): Promise<string> {
   if (permission === 'No') {
     return ''
   }
-  const res: Record<string, any> = await fetch('http://localhost:7700/keys', {
-    method: 'GET',
-    headers: {
-      Authorization: `Bearer ${MASTER_KEY}`,
-    },
-  })
-  const keys = await res.json()
+  const { results: keys } = await masterClient.getKeys()
 
   if (permission === 'Public') {
-    return keys.find((key: any) =>
+    const key = keys.find((key: any) =>
       key.description.startsWith('Default Search API')
-    ).key
+    )?.key
+    return key || ''
   }
 
   if (permission === 'Private') {
-    return keys.find((key: any) =>
+    const key = keys.find((key: any) =>
       key.description.startsWith('Default Admin API')
-    ).key
+    )?.key
+    return key || ''
   }
   return MASTER_KEY
 }