Extract models into a separate Core module

Package.swift

@@ -2,23 +2,64 @@
 
 import PackageDescription
 
+let MeiliSearch = "MeiliSearch"
+let MeiliSearchCore = "MeiliSearchCore"
+let MeiliSearchNIO = "MeiliSearchNIO"
+
+var products: [PackageDescription.Product] = [
+  .library(name: MeiliSearch, targets: [MeiliSearch]),
+  .library(name: MeiliSearchCore, targets: [MeiliSearchCore])
+]
+
+var dependencies = [PackageDescription.Package.Dependency]()
+
+var targets: [PackageDescription.Target] = [
+  .target(
+    name: MeiliSearch,
+    dependencies: [
+      .target(name: MeiliSearchCore)
+    ]
+  ),
+  .target(
+    name: MeiliSearchCore, 
+    dependencies: []
+  ),
+  .testTarget(
+    name: "MeiliSearchUnitTests",
+    dependencies: ["MeiliSearch"]
+  ),
+  .testTarget(
+    name: "MeiliSearchIntegrationTests",
+    dependencies: ["MeiliSearch"]
+  )
+]
+
+#if os(Linux) || USE_NIO
+products.append(.library(name: MeiliSearchNIO, targets: [MeiliSearchNIO]))
+dependencies.append(.package(url: "https://github.com/swift-server/async-http-client.git", from: "1.19.0"))
+targets.append(
+  .target(
+    name: MeiliSearchNIO,
+    dependencies: [
+      .product(name: "AsyncHTTPClient", package: "async-http-client"),
+      .target(name: MeiliSearchCore)
+    ]
+  )
+)
+
+targets.append(
+  .testTarget(
+    name: "MeiliSearchNIOTests",
+    dependencies: [
+      .target(name: MeiliSearchNIO)
+    ]
+  )
+)
+#endif
+
 let package = Package(
   name: "meilisearch-swift",
-  products: [
-    .library(name: "MeiliSearch", targets: ["MeiliSearch"])
-  ],
-  targets: [
-    .target(
-      name: "MeiliSearch",
-      dependencies: []
-    ),
-    .testTarget(
-      name: "MeiliSearchUnitTests",
-      dependencies: ["MeiliSearch"]
-    ),
-    .testTarget(
-      name: "MeiliSearchIntegrationTests",
-      dependencies: ["MeiliSearch"]
-    )
-  ]
+  products: products,
+  dependencies: dependencies,
+  targets: targets
 )

Sources/MeiliSearch/Async/Client+async.swift

@@ -1,4 +1,5 @@
 import Foundation
+import MeiliSearchCore
 
 @available(macOS 10.15, iOS 13, tvOS 13, watchOS 6, *)
 extension MeiliSearch {

Sources/MeiliSearch/Async/Indexes+async.swift

@@ -1,4 +1,5 @@
 import Foundation
+import MeiliSearchCore
 
 @available(macOS 10.15, iOS 13, tvOS 13, watchOS 6, *)
 extension Indexes {

Sources/MeiliSearch/Client.swift

@@ -1,6 +1,8 @@
 import Foundation
+import MeiliSearchCore
+
 #if canImport(FoundationNetworking)
-  import FoundationNetworking
+import FoundationNetworking
 #endif
 
 /**
@@ -151,8 +153,8 @@ public struct MeiliSearch {
   public func waitForTask(
     taskUid: Int,
     options: WaitOptions? = nil,
-    _ completion: @escaping (Result<Task, Swift.Error>
-  ) -> Void) {
+    _ completion: @escaping (Result<Task, Swift.Error>) -> Void
+  ) {
     self.tasks.waitForTask(taskUid: taskUid, options: options, completion)
   }
 
@@ -169,8 +171,8 @@ public struct MeiliSearch {
   public func waitForTask(
     task: TaskInfo,
     options: WaitOptions? = nil,
-    _ completion: @escaping (Result<Task, Swift.Error>
-  ) -> Void) {
+    _ completion: @escaping (Result<Task, Swift.Error>) -> Void
+  ) {
     self.tasks.waitForTask(taskUid: task.taskUid, options: options, completion)
   }
 
@@ -382,3 +384,11 @@ public struct MeiliSearch {
     self.dumps.create(completion)
   }
 }
+
+extension TaskInfo {
+  @discardableResult
+  @available(macOS 10.15, iOS 13, tvOS 13, watchOS 6, *)
+  public func wait(on client: MeiliSearch, options: WaitOptions? = nil) async throws -> Task {
+    try await client.waitForTask(task: self, options: options)
+  }
+}

Sources/MeiliSearch/Documents.swift

@@ -1,6 +1,8 @@
 import Foundation
+import MeiliSearchCore
+
 #if canImport(FoundationNetworking)
-  import FoundationNetworking
+import FoundationNetworking
 #endif
 
 struct Documents {

Sources/MeiliSearch/Dumps.swift

@@ -1,6 +1,8 @@
 import Foundation
+import MeiliSearchCore
+
 #if canImport(FoundationNetworking)
-  import FoundationNetworking
+import FoundationNetworking
 #endif
 
 /**

Sources/MeiliSearch/Error.swift

@@ -1,4 +1,6 @@
 import Foundation
+import MeiliSearchCore
+
 #if canImport(FoundationNetworking)
   import FoundationNetworking
 #endif
@@ -7,17 +9,7 @@ import Foundation
  Represent all error types in the client.
  */
 public extension MeiliSearch {
-  // MARK: Error
-  struct MSErrorResponse: Decodable, Encodable, Equatable {
-    /// A human-readable description of the error
-    public let message: String
-    /// The error code (https://www.meilisearch.com/docs/reference/errors/error_codes)
-    public let code: String
-    /// The error type (https://www.meilisearch.com/docs/reference/errors/overview#errors)
-    public let type: String
-    /// A link to the relevant section of the documentation
-    public let link: String?
-  }
+  typealias MSErrorResponse = ErrorResponse
 
   static func errorHandler(url: URL, data: Data?, response: URLResponse?, error: Swift.Error?) throws {
     // Communication Error with Meilisearch
@@ -36,7 +28,7 @@ public extension MeiliSearch {
     if let unwrappedData: Data = data, let res: MeiliSearch.MSErrorResponse = try? Constants.customJSONDecoder.decode(MeiliSearch.MSErrorResponse.self, from: unwrappedData) {
       throw MeiliSearch.Error.meiliSearchApiError(
         message: res.message,
-        msErrorResponse: MeiliSearch.MSErrorResponse(
+        msErrorResponse: MSErrorResponse(
           message: res.message,
           code: res.code,
           type: res.type,

Sources/MeiliSearch/Indexes.swift

@@ -1,4 +1,6 @@
 import Foundation
+import MeiliSearchCore
+
 #if canImport(FoundationNetworking)
   import FoundationNetworking
 #endif
@@ -1115,19 +1117,4 @@ public struct Indexes {
     _ completion: @escaping (Result<Stat, Swift.Error>) -> Void) {
     self.stats.stats(self.uid, completion)
   }
-
-  // MARK: Codable
-
-  struct UpdateIndexPayload: Codable {
-    let primaryKey: String
-  }
-
-  struct CreateIndexPayload: Codable {
-    let uid: String
-    let primaryKey: String?
-  }
-
-  public struct SwapIndexPayload: Codable, Equatable {
-    public let indexes: [String]
-  }
 }

Sources/MeiliSearch/Keys.swift

@@ -1,4 +1,6 @@
 import Foundation
+import MeiliSearchCore
+
 #if canImport(FoundationNetworking)
   import FoundationNetworking
 #endif

Sources/MeiliSearch/QueryParameters/CancelTasksQuery.swift

@@ -1,4 +1,5 @@
 import Foundation
+import MeiliSearchCore
 
 /**
  `CancelTasksQuery` class represent the options used to filter a cancel tasks call.

Sources/MeiliSearch/QueryParameters/DeleteTasksQuery.swift

@@ -1,4 +1,5 @@
 import Foundation
+import MeiliSearchCore
 
 /**
  `DeleteTasksQuery` class represent the options used to filter a delete tasks call.

Sources/MeiliSearch/QueryParameters/TasksQuery.swift

@@ -1,4 +1,6 @@
 import Foundation
+import MeiliSearchCore
+
 /**
  `TasksQuery` class represent the options used to filter a get tasks call.
  */

Sources/MeiliSearch/Request.swift

@@ -1,6 +1,8 @@
 import Foundation
+import MeiliSearchCore
+
 #if canImport(FoundationNetworking)
-  import FoundationNetworking
+import FoundationNetworking
 #endif
 
 /**

Sources/MeiliSearch/Search.swift

@@ -1,6 +1,8 @@
 import Foundation
+import MeiliSearchCore
+
 #if canImport(FoundationNetworking)
-  import FoundationNetworking
+import FoundationNetworking
 #endif
 
 struct Search {

Sources/MeiliSearch/Settings.swift

@@ -1,6 +1,8 @@
 import Foundation
+import MeiliSearchCore
+
 #if canImport(FoundationNetworking)
-  import FoundationNetworking
+import FoundationNetworking
 #endif
 
 /**

Sources/MeiliSearch/Stats.swift

@@ -1,6 +1,8 @@
 import Foundation
+import MeiliSearchCore
+
 #if canImport(FoundationNetworking)
-  import FoundationNetworking
+import FoundationNetworking
 #endif
 
 struct Stats {

Sources/MeiliSearch/System.swift

@@ -1,4 +1,6 @@
 import Foundation
+import MeiliSearchCore
+
 #if canImport(FoundationNetworking)
   import FoundationNetworking
 #endif

Sources/MeiliSearch/Tasks.swift

@@ -1,4 +1,6 @@
 import Foundation
+import MeiliSearchCore
+
 #if canImport(FoundationNetworking)
   import FoundationNetworking
 #endif

Sources/MeiliSearchCore/ErrorResponse.swift

@@ -0,0 +1,22 @@
+import Foundation
+
+public struct ErrorResponse: Error, Codable, Hashable {
+  /// A human-readable description of the error
+  public let message: String
+
+  /// The error code (https://www.meilisearch.com/docs/reference/errors/error_codes)
+  public let code: String
+
+  /// The error type (https://www.meilisearch.com/docs/reference/errors/overview#errors)
+  public let type: String
+
+  /// A link to the relevant section of the documentation
+  public let link: String?
+
+  public init(message: String, code: String, type: String, link: String? = nil) {
+    self.message = message
+    self.code = code
+    self.type = type
+    self.link = link
+  }
+}

Sources/MeiliSearch/Model/PackageVersion.swift → Sources/MeiliSearchCore/PackageVersion.swift

@@ -1,18 +1,15 @@
 import Foundation
-#if canImport(FoundationNetworking)
-  import FoundationNetworking
-#endif
 
-internal struct PackageVersion {
+public struct PackageVersion {
   /// This is the current version of the meilisearch-swift package
-  private static let current = "0.15.0"
+  public static let current = "0.15.0"
 
   /**
    Retrieves the current version of the MeiliSearch Swift package and formats accordingly.
 
    - returns: String containing the qualified version of this package eg. `Meilisearch Swift (v1.0.0)`
    */
-  static func qualifiedVersion(_ rawVersion: String? = nil) -> String {
+  public static func qualifiedVersion(_ rawVersion: String? = nil) -> String {
     "Meilisearch Swift (v\(rawVersion ?? self.current))"
   }
 }

Sources/MeiliSearchCore/Payloads.swift

@@ -0,0 +1,27 @@
+import Foundation
+
+public struct UpdateIndexPayload: Codable {
+  public let primaryKey: String
+
+  public init(primaryKey: String) {
+    self.primaryKey = primaryKey
+  }
+}
+
+public struct CreateIndexPayload: Codable {
+  public let uid: String
+  public let primaryKey: String?
+
+  public init(uid: String, primaryKey: String? = nil) {
+    self.uid = uid
+    self.primaryKey = primaryKey
+  }
+}
+
+public struct SwapIndexPayload: Codable, Equatable {
+  public let indexes: [String]
+
+  public init(indexes: [String]) {
+    self.indexes = indexes
+  }
+}

Sources/MeiliSearch/Model/Task/Task.swift → Sources/MeiliSearchCore/Task/Task.swift

@@ -36,7 +36,7 @@ public struct Task: Decodable, Equatable {
   public let canceledBy: Int?
 
   /// Error information in case of failed update.
-  public let error: MeiliSearch.MSErrorResponse?
+  public let error: ErrorResponse?
 
   public init(from decoder: Decoder) throws {
     let container = try decoder.container(keyedBy: CodingKeys.self)
@@ -51,7 +51,7 @@ public struct Task: Decodable, Equatable {
     self.startedAt = try container.decodeIfPresent(Date.self, forKey: .startedAt)
     self.finishedAt = try container.decodeIfPresent(Date.self, forKey: .finishedAt)
     self.canceledBy = try container.decodeIfPresent(Int.self, forKey: .canceledBy)
-    self.error = try container.decodeIfPresent(MeiliSearch.MSErrorResponse.self, forKey: .error)
+    self.error = try container.decodeIfPresent(ErrorResponse.self, forKey: .error)
 
     // we ignore errors thrown by `superDecoder` to handle cases where no details are provided by the API
     // for example when the type is `snapshotCreation`.

Sources/MeiliSearch/Model/Task/TaskDetails.swift → Sources/MeiliSearchCore/Task/TaskDetails.swift

@@ -83,7 +83,7 @@ public extension Task {
 
   struct TaskIndexSwapDetails: Decodable, Equatable {
     /// Object containing the payload for the indexSwap task
-    public let swaps: [Indexes.SwapIndexPayload]
+    public let swaps: [SwapIndexPayload]
   }
 
   struct TaskCancellationDetails: Decodable, Equatable {