Merge branch 'main' into bidoubiwa-patch-1

Author: bidoubiwa

.code-samples.meilisearch.yaml

@@ -41,13 +41,3 @@ jobs:
           ./meilisearch --master-key=masterKey --no-analytics true &
       - name: Run tests
         run: swift test
-
-  linter:
-    name: linter-check
-    runs-on: macos-latest
-    env:
-      DEVELOPER_DIR: /Applications/Xcode_12.4.app/Contents/Developer
-    steps:
-      - uses: actions/checkout@v2
-      - name: Run SwiftLint
-        run: sh ./Scripts/swiftlint.sh

.github/workflows/pre-release-tests.yml

@@ -128,8 +128,8 @@ To do a simply search using the client, you can create a Swift script like this:
         primaryKey: nil
     ) { result in
         switch result {
-        case .success(let update):
-            print(update) // => Update(updateId: 0)
+        case .success(let task):
+            print(task) // => Task(uid: 0, status: "enqueued", ...)
         case .failure(let error):
             print(error.localizedDescription)
         }
@@ -138,7 +138,7 @@ To do a simply search using the client, you can create a Swift script like this:
     semaphore.wait()
 ```
 
-With the `updateId`, you can check the status (`enqueued`, `processing`, `processed` or `failed`) of your documents addition using the [update endpoint](https://docs.meilisearch.com/reference/api/updates.html#get-an-update-status).
+With the `uid` of the task, you can check the status (`enqueued`, `processing`, `succeeded` or `failed`) of your documents addition using the [update endpoint](https://docs.meilisearch.com/learn/advanced/asynchronous_operations.html#task-status).
 
 #### Basic Search <!-- omit in toc -->
 
@@ -190,7 +190,7 @@ Since Meilisearch is typo-tolerant, the movie `philadelphia` is a valid search r
 
 ## 🤖 Compatibility with Meilisearch
 
-This package only guarantees the compatibility with the [version v0.24.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.24.0).
+This package only guarantees the compatibility with the [version v0.25.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.25.0).
 
 ## 💡 Learn More
 

README.md

@@ -20,6 +20,7 @@ public struct MeiliSearch {
   private let stats: Stats
   private let system: System
   private let dumps: Dumps
+  private let tasks: Tasks
 
   // MARK: Initializers
 
@@ -41,6 +42,7 @@ public struct MeiliSearch {
     self.stats = Stats(self.request)
     self.system = System(self.request)
     self.dumps = Dumps(self.request)
+    self.tasks = Tasks(self.request)
   }
 
   // MARK: Index
@@ -65,28 +67,10 @@ public struct MeiliSearch {
   public func createIndex(
     uid: String,
     primaryKey: String? = nil,
-    _ completion: @escaping (Result<Indexes, Swift.Error>) -> Void) {
+    _ completion: @escaping (Result<Task, Swift.Error>) -> Void) {
     Indexes.create(uid: uid, primaryKey: primaryKey, config: self.config, completion)
   }
 
-  /**
-   Get or create an index.
-
-  - parameter uid:        The unique identifier for the `Index` to be created.
-  - parameter primaryKey: the unique field of a document.
-  - parameter completion: The completion closure used to notify when the server
-   completes the write request, it returns a `Result` object that contains `Index`
-   value. If the request was sucessful or `Error` if a failure occured.
-   */
-
-  // DONE
-  public func getOrCreateIndex(
-    uid: String,
-    primaryKey: String? = nil,
-    _ completion: @escaping (Result<Indexes, Swift.Error>) -> Void) {
-    Indexes.getOrCreate(uid: uid, primaryKey: primaryKey, config: self.config, completion)
-  }
-
   /**
    Get an index.
 
@@ -97,7 +81,7 @@ public struct MeiliSearch {
    */
   public func getIndex(
     _ uid: String,
-    _ completion: @escaping (Result<Indexes, Swift.Error>) -> Void) {
+    _ completion: @escaping (Result<Index, Swift.Error>) -> Void) {
     self.index(uid).get(completion)
   }
 
@@ -109,7 +93,7 @@ public struct MeiliSearch {
    value. If the request was sucessful or `Error` if a failure occured.
    */
   public func getIndexes(
-    _ completion: @escaping (Result<[Indexes], Swift.Error>) -> Void) {
+    _ completion: @escaping (Result<[Index], Swift.Error>) -> Void) {
     Indexes.getAll(config: self.config, completion)
   }
 
@@ -125,7 +109,7 @@ public struct MeiliSearch {
   public func updateIndex(
     uid: String,
     primaryKey: String,
-    _ completion: @escaping (Result<Indexes, Swift.Error>) -> Void) {
+    _ completion: @escaping (Result<Task, Swift.Error>) -> Void) {
     self.index(uid).update(primaryKey: primaryKey, completion)
   }
 
@@ -139,24 +123,151 @@ public struct MeiliSearch {
    */
   public func deleteIndex(
     _ uid: String,
-    _ completion: @escaping (Result<(), Swift.Error>) -> Void) {
+    _ completion: @escaping (Result<Task, Swift.Error>) -> Void) {
     self.index(uid).delete(completion)
   }
 
+  // MARK: WAIT FOR TASK
+
+  /**
+    Wait for a task to be succesfull or failed.
+
+    Using a task returned by an asynchronous route of MeiliSearch, wait for completion.
+
+    - parameter: taskId:              The id of the task.
+    - parameter: options             Optionnal configuration for timeout and interval
+    - parameter: completion:          The completion closure used to notify when the server
+  **/
+  public func waitForTask(
+    taskUid: Int,
+    options: WaitOptions? = nil,
+    _ completion: @escaping (Result<Task, Swift.Error>
+  ) -> Void) {
+    self.tasks.waitForTask(taskUid: taskUid, options: options, completion)
+  }
+
+  /**
+    Wait for a task to be succeeded or failed.
+
+    Using a task returned by an asynchronous route of MeiliSearch, wait for completion.
+
+    - parameter task:                The task.
+    - parameter: options:             Optionnal configuration for timeout and interval
+    - parameter completion:          The completion closure used to notify when the server
+  **/
+  public func waitForTask(
+    task: Task,
+    options: WaitOptions? = nil,
+    _ completion: @escaping (Result<Task, Swift.Error>
+  ) -> Void) {
+    self.tasks.waitForTask(task: task, options: options, completion)
+  }
+
+  // MARK: Tasks
+
+ /**
+   Get the information of a task.
+
+   - parameter taskUid:    The task identifier.
+   - parameter completion: The completion closure used to notify when the server
+   completes the query request, it returns a `Result` object that contains `Key` value.
+   If the request was sucessful or `Error` if a failure occured.
+   */
+  public func getTask(
+    taskUid: Int,
+    _ completion: @escaping (Result<Task, Swift.Error>) -> Void) {
+    self.tasks.get(taskUid: taskUid, completion)
+  }
+
+  /**
+   Get all tasks.
+
+   - parameter completion: The completion closure used to notify when the server
+   completes the query request, it returns a `Result` object that contains `Key` value.
+   If the request was sucessful or `Error` if a failure occured.
+   */
+  public func getTasks(
+    _ completion: @escaping (Result<Results<Task>, Swift.Error>) -> Void) {
+    self.tasks.getAll(completion)
+  }
+
   // MARK: Keys
 
   /**
-   Protected instances of Meilisearch require API keys to perform certain actions. Only the master key has
-   the right to access the list of all API keys.
+   Get all keys.
+
+   - parameter completion: The completion closure used to notify when the server
+   completes the query request, it returns a `Result` object that contains `Key` value.
+   If the request was sucessful or `Error` if a failure occured.
+   */
+  public func getKeys(
+    _ completion: @escaping (Result<Results<Key>, Swift.Error>) -> Void) {
+    self.keys.getAll(completion)
+  }
+
+  /**
+   Get one key's information using the key value.
 
-   - parameter masterKey:  Master key to access the `keys` function.
+   - parameter key:  The key value.
    - parameter completion: The completion closure used to notify when the server
    completes the query request, it returns a `Result` object that contains `Key` value.
    If the request was sucessful or `Error` if a failure occured.
    */
-  public func keys(
+  public func getKey(
+    key: String,
+    _ completion: @escaping (Result<Key, Swift.Error>) -> Void) {
+    self.keys.get(key: key, completion)
+  }
+
+  /**
+    Create an API key.
+
+   - parameter keyParams:   Parameters object required to create a key.
+   - parameter completion:  The completion closure used to notify when the server
+   completes the query request, it returns a `Result` object that contains `Key` value.
+   If the request was sucessful or `Error` if a failure occured.
+   */
+  public func createKey(
+    _ keyParams: KeyParams,
     _ completion: @escaping (Result<Key, Swift.Error>) -> Void) {
-    self.keys.get(completion)
+    self.keys.create(keyParams, completion)
+  }
+
+  /**
+    Update an API key.
+
+   - parameter key:         The key value.
+   - parameter keyParams:   Parameters object required to update a key.
+   - parameter completion:  The completion closure used to notify when the server
+   completes the query request, it returns a `Result` object that contains `Key` value.
+   If the request was sucessful or `Error` if a failure occured.
+   */
+  public func updateKey(
+    key: String,
+    keyParams: KeyParams,
+    _ completion: @escaping (Result<Key, Swift.Error>) -> Void) {
+    self.keys.update(
+      key: key,
+      keyParams: keyParams,
+      completion
+    )
+  }
+
+  /**
+    Delete an API key.
+
+   - parameter key:  The key value.
+   - parameter completion: The completion closure used to notify when the server
+   completes the query request, it returns a `Result` object that contains `Key` value.
+   If the request was sucessful or `Error` if a failure occured.
+   */
+  public func deleteKey(
+    key: String,
+    _ completion: @escaping (Result<(), Swift.Error>) -> Void) {
+    self.keys.delete(
+      key: key,
+      completion
+    )
   }
 
   // MARK: Stats

Sources/MeiliSearch/Client.swift

@@ -12,4 +12,19 @@ struct Constants {
     encoder.dateEncodingStrategy = JSONEncoder.DateEncodingStrategy.formatted(Formatter.iso8601)
     return encoder
   }()
+
+  static func resultDecoder<T: Decodable>(data: Data?) throws -> Result<T, Swift.Error> {
+    guard let data: Data = data else {
+      return .failure(MeiliSearch.Error.dataNotFound)
+    }
+    do {
+      let task: T = try self.customJSONDecoder.decode(
+        T.self,
+        from: data)
+      return .success(task)
+    } catch {
+      return .failure(error)
+    }
+  }
+
 }

Sources/MeiliSearch/Constants.swift

@@ -19,7 +19,7 @@ struct Documents {
     _ completion: @escaping (Result<T, Swift.Error>) -> Void)
   where T: Codable, T: Equatable {
     let query: String = "/indexes/\(uid)/documents/\(identifier)"
-    request.get(api: query) { result in
+    self.request.get(api: query) { result in
       switch result {
       case .success(let data):
         guard let data: Data = data else {
@@ -69,7 +69,8 @@ struct Documents {
     _ uid: String,
     _ document: Data,
     _ primaryKey: String? = nil,
-    _ completion: @escaping (Result<Update, Swift.Error>) -> Void) {
+    _ completion: @escaping (Result<Task, Swift.Error>) -> Void) {
+
     var query: String = "/indexes/\(uid)/documents"
     if let primaryKey: String = primaryKey {
       query += "?primaryKey=\(primaryKey)"
@@ -90,7 +91,7 @@ struct Documents {
     _ documents: [T],
     _ encoder: JSONEncoder? = nil,
     _ primaryKey: String? =  nil,
-    _ completion: @escaping (Result<Update, Swift.Error>) -> Void) where T: Encodable {
+    _ completion: @escaping (Result<Task, Swift.Error>) -> Void) where T: Encodable {
     var query: String = "/indexes/\(uid)/documents"
     if let primaryKey: String = primaryKey {
       query += "?primaryKey=\(primaryKey)"
@@ -119,7 +120,8 @@ struct Documents {
     _ uid: String,
     _ document: Data,
     _ primaryKey: String? = nil,
-    _ completion: @escaping (Result<Update, Swift.Error>) -> Void) {
+    _ completion: @escaping (Result<Task, Swift.Error>) -> Void) {
+
     var query: String = "/indexes/\(uid)/documents"
     if let primaryKey: String = primaryKey {
       query += "?primaryKey=\(primaryKey)"
@@ -140,7 +142,8 @@ struct Documents {
     _ documents: [T],
     _ encoder: JSONEncoder? = nil,
     _ primaryKey: String? =  nil,
-    _ completion: @escaping (Result<Update, Swift.Error>) -> Void) where T: Encodable {
+    _ completion: @escaping (Result<Task, Swift.Error>) -> Void) where T: Encodable {
+
     var query: String = "/indexes/\(uid)/documents"
     if let primaryKey: String = primaryKey {
       query += "?primaryKey=\(primaryKey)"
@@ -170,18 +173,17 @@ struct Documents {
   func delete(
     _ uid: String,
     _ identifier: String,
-    _ completion: @escaping (Result<Update, Swift.Error>) -> Void) {
+    _ completion: @escaping (Result<Task, Swift.Error>) -> Void) {
+
     self.request.delete(api: "/indexes/\(uid)/documents/\(identifier)") { result in
       switch result {
-      case .success(let result):
-
-        guard let result: Data = result else {
+      case .success(let data):
+        guard let data: Data = data else {
           completion(.failure(MeiliSearch.Error.dataNotFound))
           return
         }
 
-        Documents.decodeJSON(result, completion: completion)
-
+        Documents.decodeJSON(data, completion: completion)
       case .failure(let error):
         completion(.failure(error))
       }
@@ -190,7 +192,8 @@ struct Documents {
 
   func deleteAll(
     _ uid: String,
-    _ completion: @escaping (Result<Update, Swift.Error>) -> Void) {
+    _ completion: @escaping (Result<Task, Swift.Error>) -> Void) {
+
     self.request.delete(api: "/indexes/\(uid)/documents") { result in
       switch result {
       case .success(let data):
@@ -211,7 +214,8 @@ struct Documents {
   func deleteBatch(
     _ uid: String,
     _ documentsIdentifiers: [Int],
-    _ completion: @escaping (Result<Update, Swift.Error>) -> Void) {
+    _ completion: @escaping (Result<Task, Swift.Error>) -> Void) {
+
     let data: Data
 
     do {