Update key route (#1123)

* Change updates to tasks

* Complete implementation of asynchronous index CRUD

* Add client tests

* Add index tests

* Add documents test

* Improve js doc

* Add distinct attributes tests

* Add distrinct attributes tests

* Remove unused variable from tests

* Add dump tests

* Add filterable attributes tests

* Add ranking rules tests

* Add settings tests

* Add sortable attr tests

* Add stop words

* Fix types for Tasks

* Add search tests

* Finish tests compatibility

* Fix tasks issues

* Fix tests

* Fix task type

* Add await in return statement

* Fix tests

* Fix node12 jest tests

* Fix tests environments

* Remove obsolete test

* Fix tests

* Fix document tests

* Update update information in readme

* Add type check test

* Fix types of env

* Put back express tests to check for CORS issues

* Remove env from typescript type test

* Add new keys API

* Apply suggestions from code review

Co-authored-by: Amélie <[email protected]>

Co-authored-by: Amélie <[email protected]>

Author: bidoubiwa

README.md

@@ -600,10 +600,26 @@ Using the index object:
 
 ### Keys <!-- omit in toc -->
 
-- [Get keys](https://docs.meilisearch.com/reference/api/keys.html#get-keys):
+- [Get keys](https://docs.meilisearch.com/reference/api/keys.html#get-all-keys):
 
 `client.getKeys(): Promise<Keys>`
 
+- [Get one key](https://docs.meilisearch.com/reference/api/keys.html#get-one-key):
+
+`client.getKey(key: string): Promise<Key>`
+
+- [Create a key](https://docs.meilisearch.com/reference/api/keys.html#create-a-key):
+
+`client.createKey(options: KeyPayload): Promise<Key>`
+
+- [Update a key](https://docs.meilisearch.com/reference/api/keys.html#update-a-key):
+
+`client.updateKey(key: string, options: KeyPayload): Promise<Key>`
+
+- [Delete a key](https://docs.meilisearch.com/reference/api/keys.html#delete-a-key):
+
+`client.deleteKey(key: string): Promise<void>`
+
 ### isHealthy <!-- omit in toc -->
 
 - [Return `true` or `false` depending on the health of the server](https://docs.meilisearch.com/reference/api/health.html#get-health):

src/lib/http-requests.ts

@@ -136,6 +136,21 @@ class HttpRequests {
     })
   }
 
+  async patch(
+    url: string,
+    data?: any,
+    params?: { [key: string]: any },
+    config?: Record<string, any>
+  ): Promise<any> {
+    return await this.request({
+      method: 'PATCH',
+      url,
+      body: data,
+      params,
+      config,
+    })
+  }
+
   async delete(
     url: string,
     data?: any,

src/lib/meilisearch.ts

@@ -9,18 +9,21 @@
 
 import { Index } from './indexes'
 import {
+  KeyPayload,
   Config,
   IndexOptions,
   IndexResponse,
   EnqueuedTask,
-  Keys,
+  Key,
   Health,
   Stats,
   Version,
   EnqueuedDump,
   ErrorStatusCode,
   Task,
   Tasks,
+  // FIXME: Should be used in GET /keys
+  // Result,
 } from '../types'
 import { HttpRequests } from './http-requests'
 import { addProtocolIfNotPresent } from './utils'
@@ -62,7 +65,7 @@ class MeiliSearch {
    * @method getIndex
    * @template T
    * @param {string} indexUid The index UID
-   * @returns {Promise<Index<T>>} Promise containing Index instance
+   * @returns {Promise<Index<T>>} Promise returning Index instance
    */
   async getIndex<T = any>(indexUid: string): Promise<Index<T>> {
     return new Index<T>(this.config, indexUid).fetchInfo()
@@ -74,7 +77,7 @@ class MeiliSearch {
    * @memberof MeiliSearch
    * @method getRawIndex
    * @param {string} indexUid The index UID
-   * @returns {Promise<IndexResponse>} Promise containing index information
+   * @returns {Promise<IndexResponse>} Promise returning index information
    */
   async getRawIndex(indexUid: string): Promise<IndexResponse> {
     return new Index(this.config, indexUid).getRawInfo()
@@ -87,7 +90,7 @@ class MeiliSearch {
    * @template T
    * @param {string} uid The index UID
    * @param {IndexOptions} options Index options
-   * @returns {Promise<Index<T>>} Promise containing Index instance
+   * @returns {Promise<Index<T>>} Promise returning Index instance
    */
   // TODO: to discuss
   // async getOrCreateIndex<T = any>(
@@ -109,7 +112,7 @@ class MeiliSearch {
    * Get all indexes in the database
    * @memberof MeiliSearch
    * @method getIndexes
-   * @returns {Promise<IndexResponse[]>} Promise containing array of raw index information
+   * @returns {Promise<IndexResponse[]>} Promise returning array of raw index information
    */
   async getIndexes(): Promise<IndexResponse[]> {
     const url = `indexes`
@@ -123,7 +126,7 @@ class MeiliSearch {
    * @template T
    * @param {string} uid The index UID
    * @param {IndexOptions} options Index options
-   * @returns {Promise<Index<T>>} Promise containing Index instance
+   * @returns {Promise<Index<T>>} Promise returning Index instance
    */
   async createIndex(
     uid: string,
@@ -139,7 +142,7 @@ class MeiliSearch {
    * @template T
    * @param {string} uid The index UID
    * @param {IndexOptions} options Index options to update
-   * @returns {Promise<Index<T>>} Promise containing Index instance after updating
+   * @returns {Promise<Index<T>>} Promise returning Index instance after updating
    */
   async updateIndex(
     uid: string,
@@ -186,7 +189,7 @@ class MeiliSearch {
    * Get the list of all client tasks
    * @memberof MeiliSearch
    * @method getTasks
-   * @returns {Promise<Tasks>} - Promise containing all tasks
+   * @returns {Promise<Tasks>} - Promise returning all tasks
    */
   async getTasks(): Promise<Tasks> {
     return await this.tasks.getClientTasks()
@@ -197,7 +200,7 @@ class MeiliSearch {
    * @memberof MeiliSearch
    * @method getTask
    * @param {number} taskId - Task identifier
-   * @returns {Promise<Task>} - Promise containing a task
+   * @returns {Promise<Task>} - Promise returning a task
    */
   async getTask(taskId: number): Promise<Task> {
     return await this.tasks.getClientTask(taskId)
@@ -210,7 +213,7 @@ class MeiliSearch {
    * @param {number[]} taskIds - Tasks identifier
    * @param {WaitOptions} waitOptions - Options on timeout and interval
    *
-   * @returns {Promise<Tasks>} - Promise containing an array of tasks
+   * @returns {Promise<Tasks>} - Promise returning an array of tasks
    */
   async waitForTasks(
     taskIds: number[],
@@ -233,7 +236,7 @@ class MeiliSearch {
    * @param {number} taskId - Task identifier
    * @param {WaitOptions} waitOptions - Options on timeout and interval
    *
-   * @returns {Promise<Task>} - Promise containing an array of tasks
+   * @returns {Promise<Task>} - Promise returning an array of tasks
    */
   async waitForTask(
     taskId: number,
@@ -253,14 +256,68 @@ class MeiliSearch {
   ///
 
   /**
-   * Get private and public key
+   * Get all API keys
+   * @memberof MeiliSearch
+   * @method getKeys
+   * @returns {Promise<Keys>} Promise returning an object with keys
+   */
+  // FIXME: should be Result<Key[]>>
+  async getKeys(): Promise<Key[]> {
+    const url = `keys`
+    return await this.httpRequest.get<Key[]>(url)
+  }
+
+  /**
+   * Get one API key
    * @memberof MeiliSearch
    * @method getKey
-   * @returns {Promise<Keys>} Promise containing an object with keys
+   *
+   * @param {string} key - Key
+   * @returns {Promise<Keys>} Promise returning a key
+   */
+  async getKey(key: string): Promise<Key> {
+    const url = `keys/${key}`
+    return await this.httpRequest.get<Key>(url)
+  }
+
+  /**
+   * Create one API key
+   * @memberof MeiliSearch
+   * @method createKey
+   *
+   * @param {KeyPayload} options - Key options
+   * @returns {Promise<Key>} Promise returning an object with keys
    */
-  async getKeys(): Promise<Keys> {
+  async createKey(options: KeyPayload): Promise<Key> {
     const url = `keys`
-    return await this.httpRequest.get<Keys>(url)
+    return await this.httpRequest.post(url, options)
+  }
+
+  /**
+   * Update one API key
+   * @memberof MeiliSearch
+   * @method updateKey
+   *
+   * @param {string} key - Key
+   * @param {KeyPayload} options - Key options
+   * @returns {Promise<Key>} Promise returning an object with keys
+   */
+  async updateKey(key: string, options: KeyPayload): Promise<Key> {
+    const url = `keys/${key}`
+    return await this.httpRequest.patch(url, options)
+  }
+
+  /**
+   * Delete one API key
+   * @memberof MeiliSearch
+   * @method deleteKey
+   *
+   * @param {string} key - Key
+   * @returns {Promise<Void>}
+   */
+  async deleteKey(key: string): Promise<void> {
+    const url = `keys/${key}`
+    return await this.httpRequest.delete<any>(url)
   }
 
   ///
@@ -271,7 +328,7 @@ class MeiliSearch {
    * Checks if the server is healthy, otherwise an error will be thrown.
    * @memberof MeiliSearch
    * @method health
-   * @returns {Promise<Health>} Promise containing an object with health details
+   * @returns {Promise<Health>} Promise returning an object with health details
    */
   async health(): Promise<Health> {
     const url = `health`
@@ -282,7 +339,7 @@ class MeiliSearch {
    * Checks if the server is healthy, return true or false.
    * @memberof MeiliSearch
    * @method isHealthy
-   * @returns {Promise<boolean>} Promise containing a boolean
+   * @returns {Promise<boolean>} Promise returning a boolean
    */
   async isHealthy(): Promise<boolean> {
     try {
@@ -302,7 +359,7 @@ class MeiliSearch {
    * Get the stats of all the database
    * @memberof MeiliSearch
    * @method getStats
-   * @returns {Promise<Stats>} Promise containing object of all the stats
+   * @returns {Promise<Stats>} Promise returning object of all the stats
    */
   async getStats(): Promise<Stats> {
     const url = `stats`
@@ -317,7 +374,7 @@ class MeiliSearch {
    * Get the version of MeiliSearch
    * @memberof MeiliSearch
    * @method getVersion
-   * @returns {Promise<Version>} Promise containing object with version details
+   * @returns {Promise<Version>} Promise returning object with version details
    */
   async getVersion(): Promise<Version> {
     const url = `version`
@@ -332,7 +389,7 @@ class MeiliSearch {
    * Triggers a dump creation process
    * @memberof MeiliSearch
    * @method createDump
-   * @returns {Promise<EnqueuedDump>} Promise containing object of the enqueued update
+   * @returns {Promise<EnqueuedDump>} Promise returning object of the enqueued update
    */
   async createDump(): Promise<EnqueuedDump> {
     const url = `dumps`
@@ -344,7 +401,7 @@ class MeiliSearch {
    * @memberof MeiliSearch
    * @method getDumpStatus
    * @param {string} dumpUid Dump UID
-   * @returns {Promise<EnqueuedDump>} Promise containing object of the enqueued update
+   * @returns {Promise<EnqueuedDump>} Promise returning object of the enqueued update
    */
   async getDumpStatus(dumpUid: string): Promise<EnqueuedDump> {
     const url = `dumps/${dumpUid}/status`

src/types/types.ts

@@ -10,6 +10,10 @@ export type Config = {
   headers?: object
 }
 
+export type Result<T> = {
+  results: T
+}
+
 ///
 /// Request specific interfaces
 ///
@@ -235,9 +239,21 @@ export type Stats = {
  ** Keys
  */
 
-export type Keys = {
-  private: string | null
-  public: string | null
+export type Key = {
+  description: string
+  key: string
+  actions: string[]
+  indexes: string[]
+  expiresAt: string
+  createdAt: string
+  updateAt: string
+}
+
+export type KeyPayload = {
+  description?: string
+  actions: string[]
+  indexes: string[]
+  expiresAt: string | null
 }
 
 /*
@@ -355,6 +371,24 @@ export const enum ErrorStatusCode {
   /** @see https://docs.meilisearch.com/errors/#invalid_api_key */
   INVALID_API_KEY = 'invalid_api_key',
 
+  /** @see https://docs.meilisearch.com/errors/#invalid_api_key_description */
+  INVALID_API_KEY_DESCRIPTION = 'invalid_api_key_description',
+
+  /** @see https://docs.meilisearch.com/errors/#invalid_api_key_actions */
+  INVALID_API_KEY_ACTIONS = 'invalid_api_key_actions',
+
+  /** @see https://docs.meilisearch.com/errors/#invalid_api_key_indexes */
+  INVALID_API_KEY_INDEXES = 'invalid_api_key_indexes',
+
+  /** @see https://docs.meilisearch.com/errors/#invalid_api_key_expires_at */
+  INVALID_API_KEY_EXPIRES_AT = 'invalid_api_key_expires_at',
+
+  /** @see https://docs.meilisearch.com/errors/#api_key_not_found */
+  API_KEY_NOT_FOUND = 'api_key_not_found',
+
+  /** @see https://docs.meilisearch.com/errors/#missing_parameter */
+  MISSING_PARAMETER = 'missing_parameter',
+
   /** @see https://docs.meilisearch.com/errors/#missing_authorization_header */
   MISSING_AUTHORIZATION_HEADER = 'missing_authorization_header',