Add KeyActions enum and rename Task

.swiftlint.yml

@@ -9,6 +9,7 @@ disabled_rules:
   - identifier_name
   - function_body_length
   - trailing_comma
+  - cyclomatic_complexity
 
 analyzer_rules:
   - unused_declaration

Sources/MeiliSearch/Async/Client+async.swift

@@ -71,7 +71,7 @@ extension MeiliSearch {
   /**
    See `waitForTask(taskUid:options:_:)`
    */
-  public func waitForTask(taskUid: Int, options: WaitOptions? = nil) async throws -> Task {
+  public func waitForTask(taskUid: Int, options: WaitOptions? = nil) async throws -> MTask {
     try await withCheckedThrowingContinuation { continuation in
       self.waitForTask(taskUid: taskUid, options: options) { result in
         continuation.resume(with: result)
@@ -82,7 +82,7 @@ extension MeiliSearch {
   /**
    See `waitForTask(task:options:_:)`
    */
-  public func waitForTask(task: TaskInfo, options: WaitOptions? = nil) async throws -> Task {
+  public func waitForTask(task: TaskInfo, options: WaitOptions? = nil) async throws -> MTask {
     try await withCheckedThrowingContinuation { continuation in
       self.waitForTask(task: task, options: options) { result in
         continuation.resume(with: result)
@@ -93,7 +93,7 @@ extension MeiliSearch {
   /**
    See `getTask(taskUid:_:)`
    */
-  public func getTask(taskUid: Int) async throws -> Task {
+  public func getTask(taskUid: Int) async throws -> MTask {
     try await withCheckedThrowingContinuation { continuation in
       self.getTask(taskUid: taskUid) { result in
         continuation.resume(with: result)

Sources/MeiliSearch/Async/Indexes+async.swift

@@ -159,7 +159,7 @@ extension Indexes {
   /**
    See `getTask(taskUid:_:)`
    */
-  public func getTask(taskUid: Int) async throws -> Task {
+  public func getTask(taskUid: Int) async throws -> MTask {
     try await withCheckedThrowingContinuation { continuation in
       self.getTask(taskUid: taskUid) { result in
         continuation.resume(with: result)

Sources/MeiliSearch/Client.swift

@@ -153,7 +153,7 @@ public struct MeiliSearch {
   public func waitForTask(
     taskUid: Int,
     options: WaitOptions? = nil,
-    _ completion: @escaping (Result<Task, Swift.Error>
+    _ completion: @escaping (Result<MTask, Swift.Error>
   ) -> Void) {
     self.tasks.waitForTask(taskUid: taskUid, options: options, completion)
   }
@@ -171,7 +171,7 @@ public struct MeiliSearch {
   public func waitForTask(
     task: TaskInfo,
     options: WaitOptions? = nil,
-    _ completion: @escaping (Result<Task, Swift.Error>
+    _ completion: @escaping (Result<MTask, Swift.Error>
   ) -> Void) {
     self.tasks.waitForTask(taskUid: task.taskUid, options: options, completion)
   }
@@ -188,7 +188,7 @@ public struct MeiliSearch {
    */
   public func getTask(
     taskUid: Int,
-    _ completion: @escaping (Result<Task, Swift.Error>) -> Void) {
+    _ completion: @escaping (Result<MTask, Swift.Error>) -> Void) {
     self.tasks.get(taskUid: taskUid, completion)
   }
 

Sources/MeiliSearch/Indexes.swift

@@ -515,7 +515,7 @@ public struct Indexes {
    */
   public func getTask(
     taskUid: Int,
-    _ completion: @escaping (Result<Task, Swift.Error>) -> Void) {
+    _ completion: @escaping (Result<MTask, Swift.Error>) -> Void) {
     self.tasks.get(taskUid: taskUid, completion)
   }
 

Sources/MeiliSearch/Model/Key.swift

@@ -19,7 +19,7 @@ public struct Key: Codable, Equatable {
   /// An alphanumeric key value generated by Meilisearch by hashing the uid and the master key on API key creation.
   public let key: String
   /// An array of API actions permitted for the key.
-  public let actions: [String]
+  public let actions: [KeyAction]
   /// An array of strings (indexes names) the key is authorized to act on.
   public let indexes: [String]
   /// Date and time when the key will expire, represented in RFC 3339 format.
@@ -29,3 +29,4 @@ public struct Key: Codable, Equatable {
   /// Date and time when the key was last updated, represented in RFC 3339 format.
   public let updatedAt: String
 }
+

Sources/MeiliSearch/Model/KeyAction.swift

@@ -0,0 +1,202 @@
+///Documentation: https://www.meilisearch.com/docs/reference/api/keys#actions
+public enum KeyAction: Equatable, Codable {
+  case wildcard
+  case search
+  case documentsWildcard
+  case documentsAdd
+  case documentsGet
+  case documentsDelete
+  case indexesWildcard
+  case indexesCreate
+  case indexesGet
+  case indexesUpdate
+  case indexesDelete
+  case indexesSwap
+  case tasksWildcard
+  case tasksGet
+  case tasksCancel
+  case tasksDelete
+  case settingsWildcard
+  case settingsGet
+  case settingsUpdate
+  case statsGet
+  case dumpsCreate
+  case snapshotsCreate
+  case version
+  case keysGet
+  case keysCreate
+  case keysUpdate
+  case keysDelete
+  case unknown(String)
+
+  public init(from decoder: Decoder) throws {
+    let container = try decoder.singleValueContainer()
+    let rawValue = try container.decode(String.self)
+
+    self = KeyAction(rawValue)
+  }
+
+  public func encode(to encoder: Encoder) throws {
+    var container = encoder.singleValueContainer()
+
+    try container.encode(self.value)
+  }
+}
+
+public extension KeyAction {
+  init(_ value: String) {
+    self = switch value {
+    case "*":
+      .wildcard
+    case "search":
+      .search
+    case "documents.*":
+      .documentsWildcard
+    case "documents.add":
+      .documentsAdd
+    case "documents.get":
+      .documentsGet
+    case "documents.delete":
+      .documentsDelete
+    case "indexes.*":
+      .indexesWildcard
+    case "indexes.create":
+      .indexesCreate
+    case "indexes.get":
+      .indexesGet
+    case "indexes.update":
+      .indexesUpdate
+    case "indexes.delete":
+      .indexesDelete
+    case "indexes.swap":
+        .indexesSwap
+    case "tasks.*":
+        .tasksWildcard
+    case "tasks.get":
+        .tasksGet
+    case "tasks.cancel":
+        .tasksCancel
+    case "tasks.delete":
+        .tasksDelete
+    case "settings.*":
+        .settingsWildcard
+    case "settings.get":
+        .settingsGet
+    case "settings.update":
+        .settingsUpdate
+    case "stats.get":
+        .statsGet
+    case "dumps.create":
+        .dumpsCreate
+    case "snapshots.create":
+        .snapshotsCreate
+    case "version":
+        .version
+    case "keys.get":
+        .keysGet
+    case "keys.create":
+        .keysCreate
+    case "keys.update":
+        .keysUpdate
+    case "keys.delete":
+        .keysDelete
+    default:
+        .unknown(value)
+    }
+  }
+
+  var value: String {
+    switch self {
+    case .wildcard:
+      "*"
+    case .search:
+      "search"
+    case .documentsWildcard:
+      "documents.*"
+    case .documentsAdd:
+      "documents.add"
+    case .documentsGet:
+      "documents.get"
+    case .documentsDelete:
+      "documents.delete"
+    case .indexesWildcard:
+      "indexes.*"
+    case .indexesCreate:
+      "indexes.create"
+    case .indexesGet:
+      "indexes.get"
+    case .indexesUpdate:
+      "indexes.update"
+    case .indexesDelete:
+      "indexes.delete"
+    case .indexesSwap:
+      "indexes.swap"
+    case .tasksWildcard:
+      "tasks.*"
+    case .tasksGet:
+      "tasks.get"
+    case .tasksCancel:
+      "tasks.cancel"
+    case .tasksDelete:
+      "tasks.delete"
+    case .settingsWildcard:
+      "settings.*"
+    case .settingsGet:
+      "settings.get"
+    case .settingsUpdate:
+      "settings.update"
+    case .statsGet:
+      "stats.get"
+    case .dumpsCreate:
+      "dumps.create"
+    case .snapshotsCreate:
+      "snapshots.create"
+    case .version:
+      "version"
+    case .keysGet:
+      "keys.get"
+    case .keysCreate:
+      "keys.create"
+    case .keysUpdate:
+      "keys.update"
+    case .keysDelete:
+      "keys.delete"
+    case .unknown(let string):
+      string
+    }
+  }
+}
+
+extension KeyAction: CaseIterable {
+  public static var allCases: [KeyAction] {
+    [
+      .wildcard,
+      .search,
+      .documentsWildcard,
+      .documentsAdd,
+      .documentsGet,
+      .documentsDelete,
+      .indexesWildcard,
+      .indexesCreate,
+      .indexesGet,
+      .indexesUpdate,
+      .indexesDelete,
+      .indexesSwap,
+      .tasksWildcard,
+      .tasksGet,
+      .tasksCancel,
+      .tasksDelete,
+      .settingsWildcard,
+      .settingsGet,
+      .settingsUpdate,
+      .statsGet,
+      .dumpsCreate,
+      .snapshotsCreate,
+      .version,
+      .keysGet,
+      .keysCreate,
+      .keysUpdate,
+      .keysDelete,
+    ]
+  }
+}

Sources/MeiliSearch/Model/KeyParams.swift

@@ -14,7 +14,7 @@ public struct KeyParams: Codable, Equatable {
   /// A uuid v4 to identify the API key. If not specified, it is automatically generated by Meilisearch.
   public var uid: String?
   /// An array of API actions permitted for the key.
-  public let actions: [String]
+  public let actions: [KeyAction]
   /// An array of strings (indexes names) the key is authorized to act on.
   public let indexes: [String]
   /// Date and time when the key will expire, represented in RFC 3339 format.
@@ -24,7 +24,7 @@ public struct KeyParams: Codable, Equatable {
     description: String? = nil,
     name: String? = nil,
     uid: String? = nil,
-    actions: [String],
+    actions: [KeyAction],
     indexes: [String],
     expiresAt: String?
   ) {

Sources/MeiliSearch/Model/Task/Task.swift

@@ -4,7 +4,7 @@ import Foundation
  `Task` instances represent the current transaction status, use the `uid` value to
   verify the status of your transaction.
  */
-public struct Task: Decodable, Equatable {
+public struct MTask: Decodable, Equatable {
   /// Unique ID for the current `Task`.
   public let uid: Int
 

Sources/MeiliSearch/Model/Task/TaskDetails.swift

@@ -1,6 +1,6 @@
 import Foundation
 
-public extension Task {
+public extension MTask {
   enum Details: Equatable {
     case indexCreation(TaskIndexCreationDetails)
     case indexUpdate(TaskIndexUpdateDetails)

Sources/MeiliSearch/Model/Task/TaskInfo.swift

@@ -12,7 +12,7 @@ public struct TaskInfo: Codable, Equatable {
   public let indexUid: String?
 
   /// Returns if the task has been successful or not.
-  public let status: Task.Status
+  public let status: MTask.Status
 
   /// Type of the task.
   public let type: TaskType
@@ -26,7 +26,7 @@ public struct TaskInfo: Codable, Equatable {
 
   @discardableResult
   @available(macOS 10.15, iOS 13, tvOS 13, watchOS 6, *)
-  public func wait(on client: MeiliSearch, options: WaitOptions? = nil) async throws -> Task {
+  public func wait(on client: MeiliSearch, options: WaitOptions? = nil) async throws -> MTask {
     try await client.waitForTask(task: self, options: options)
   }
 }

Sources/MeiliSearch/Model/Task/TaskStatus.swift

@@ -1,6 +1,6 @@
 import Foundation
 
-public extension Task {
+public extension MTask {
   enum Status: String, Codable, Equatable {
     /// When a task was successfully enqueued and is waiting to be processed.
     case enqueued

Sources/MeiliSearch/Model/Task/TasksResults.swift

@@ -5,7 +5,7 @@ import Foundation
  */
 public struct TasksResults: Decodable, Equatable {
   /// Results list containing objects of `Task`.
-  public let results: [Task]
+  public let results: [MTask]
   /// Integer value used to retrieve the next batch of tasks.
   public let next: Int?
   /// Integer value representing the first `uid` of the first task returned.

Sources/MeiliSearch/QueryParameters/CancelTasksQuery.swift

@@ -7,7 +7,7 @@ public class CancelTasksQuery: Queryable {
   /// List of strings with all the types the response should contain.
   public let types: [TaskType]
   /// List of strings with all the statuses the response should contain.
-  public let statuses: [Task.Status]
+  public let statuses: [MTask.Status]
   /// Filter tasks response by a particular list of index Uids strings
   public let indexUids: [String]
   /// Filter tasks based on a list of task's uids.
@@ -22,7 +22,7 @@ public class CancelTasksQuery: Queryable {
   public let afterStartedAt: Date?
 
   init(
-    types: [TaskType]? = nil, statuses: [Task.Status]? = nil,
+    types: [TaskType]? = nil, statuses: [MTask.Status]? = nil,
     indexUids: [String]? = nil, uids: [Int]? = nil,
     beforeEnqueuedAt: Date? = nil, afterEnqueuedAt: Date? = nil,
     beforeStartedAt: Date? = nil, afterStartedAt: Date? = nil