Swift 6 support (#40)

.github/workflows/code-quality.yml

@@ -8,18 +8,21 @@ on:
     branches:
       - main
 
+env:
+  DEVELOPER_DIR: /Applications/Xcode_16.1.app/Contents/Developer
+
 jobs:
   test-ios:
-    runs-on: macos-13
+    runs-on: macos-15
 
     steps:
       - uses: actions/checkout@v3
 
       - name: Build and test
-        run: xcodebuild test -scheme OllamaKit -destination 'platform=iOS Simulator,name=iPhone 14 Pro'
+        run: xcodebuild test -scheme OllamaKit -destination 'platform=iOS Simulator,name=iPhone 16 Pro'
 
   test-macos:
-    runs-on: macos-13
+    runs-on: macos-15
 
     steps:
       - uses: actions/checkout@v3

.github/workflows/deploy-docs.yml

@@ -13,9 +13,12 @@ concurrency:
   group: "pages"
   cancel-in-progress: false
 
+env:
+  DEVELOPER_DIR: /Applications/Xcode_16.1.app/Contents/Developer
+
 jobs:
   deploy:
-    runs-on: macos-13
+    runs-on: macos-15
 
     environment:
       name: github-pages

Package.swift

@@ -1,4 +1,4 @@
-// swift-tools-version: 5.9
+// swift-tools-version: 6.0
 // The swift-tools-version declares the minimum version of Swift required to build this package.
 
 import PackageDescription

Package@swift-5.9.swift

@@ -0,0 +1,29 @@
+// swift-tools-version: 5.9
+// The swift-tools-version declares the minimum version of Swift required to build this package.
+
+import PackageDescription
+
+let package = Package(
+    name: "OllamaKit",
+    platforms: [
+        .iOS(.v15),
+        .macOS(.v12),
+        .macCatalyst(.v15)
+    ],
+    products: [
+        .library(
+            name: "OllamaKit",
+            targets: ["OllamaKit"]),
+    ],
+    dependencies: [
+        .package(url: "https://github.com/apple/swift-docc-plugin.git", .upToNextMajor(from: "1.3.0"))
+    ],
+    targets: [
+        .target(
+            name: "OllamaKit",
+            dependencies: []),
+        .testTarget(
+            name: "OllamaKitTests",
+            dependencies: ["OllamaKit"]),
+    ]
+)

Playground/OKPlayground.xcodeproj/project.pbxproj

@@ -366,7 +366,7 @@
 				PRODUCT_BUNDLE_IDENTIFIER = com.kevinhermawan.OKPlayground;
 				PRODUCT_NAME = "$(TARGET_NAME)";
 				SWIFT_EMIT_LOC_STRINGS = YES;
-				SWIFT_VERSION = 5.0;
+				SWIFT_VERSION = 6.0;
 				TARGETED_DEVICE_FAMILY = "1,2";
 			};
 			name = Debug;
@@ -396,7 +396,7 @@
 				PRODUCT_BUNDLE_IDENTIFIER = com.kevinhermawan.OKPlayground;
 				PRODUCT_NAME = "$(TARGET_NAME)";
 				SWIFT_EMIT_LOC_STRINGS = YES;
-				SWIFT_VERSION = 5.0;
+				SWIFT_VERSION = 6.0;
 				TARGETED_DEVICE_FAMILY = "1,2";
 			};
 			name = Release;

Playground/OKPlayground/ViewModels/ViewModel.swift

@@ -9,6 +9,7 @@ import Foundation
 import OllamaKit
 
 @Observable
+@MainActor
 final class ViewModel {
     var ollamaKit = OllamaKit()
 

Sources/OllamaKit/OllamaKit+Chat.swift

@@ -100,8 +100,8 @@ extension OllamaKit {
     /// - Returns: An `AsyncThrowingStream<OKChatResponse, Error>` emitting the live stream of chat responses from the Ollama API.
     public func chat(data: OKChatRequestData) -> AsyncThrowingStream<OKChatResponse, Error> {
         do {
-            let request = try OKRouter.chat(data: data).asURLRequest()
-            
+            let request = try OKRouter.chat(data: data).asURLRequest(with: baseURL)
+
             return OKHTTPClient.shared.stream(request: request, with: OKChatResponse.self)
         } catch {
             return AsyncThrowingStream { continuation in
@@ -197,8 +197,8 @@ extension OllamaKit {
     /// - Returns: An `AnyPublisher<OKChatResponse, Error>` emitting the live stream of chat responses from the Ollama API.
     public func chat(data: OKChatRequestData) -> AnyPublisher<OKChatResponse, Error> {
         do {
-            let request = try OKRouter.chat(data: data).asURLRequest()
-            
+            let request = try OKRouter.chat(data: data).asURLRequest(with: baseURL)
+
             return OKHTTPClient.shared.stream(request: request, with: OKChatResponse.self)
         } catch {
             return Fail(error: error).eraseToAnyPublisher()

Sources/OllamaKit/OllamaKit+CopyModel.swift

@@ -22,8 +22,8 @@ extension OllamaKit {
     /// - Parameter data: The ``OKCopyModelRequestData`` containing the details needed to copy the model.
     /// - Throws: An error if the request to copy the model fails.
     public func copyModel(data: OKCopyModelRequestData) async throws -> Void {
-        let request = try OKRouter.copyModel(data: data).asURLRequest()
-        
+        let request = try OKRouter.copyModel(data: data).asURLRequest(with: baseURL)
+
         try await OKHTTPClient.shared.send(request: request)
     }
 
@@ -48,7 +48,7 @@ extension OllamaKit {
     /// - Returns: A `AnyPublisher<Void, Error>` that completes when the copy operation is done.
     public func copyModel(data: OKCopyModelRequestData) -> AnyPublisher<Void, Error> {
         do {
-            let request = try OKRouter.copyModel(data: data).asURLRequest()
+            let request = try OKRouter.copyModel(data: data).asURLRequest(with: baseURL)
 
             return OKHTTPClient.shared.send(request: request)
         } catch {

Sources/OllamaKit/OllamaKit+DeleteModel.swift

@@ -22,8 +22,8 @@ extension OllamaKit {
     /// - Parameter data: The ``OKDeleteModelRequestData`` containing the details needed to delete the model.
     /// - Throws: An error if the request to delete the model fails.
     public func deleteModel(data: OKDeleteModelRequestData) async throws -> Void {
-        let request = try OKRouter.deleteModel(data: data).asURLRequest()
-        
+        let request = try OKRouter.deleteModel(data: data).asURLRequest(with: baseURL)
+
         try await OKHTTPClient.shared.send(request: request)
     }
 
@@ -48,7 +48,7 @@ extension OllamaKit {
     /// - Returns: A `AnyPublisher<Void, Error>` that completes when the deletion operation is done.
     public func deleteModel(data: OKDeleteModelRequestData) -> AnyPublisher<Void, Error> {
         do {
-            let request = try OKRouter.deleteModel(data: data).asURLRequest()
+            let request = try OKRouter.deleteModel(data: data).asURLRequest(with: baseURL)
 
             return OKHTTPClient.shared.send(request: request)
         } catch {

Sources/OllamaKit/OllamaKit+Embeddings.swift

@@ -23,8 +23,8 @@ extension OllamaKit {
     /// - Returns: An ``OKEmbeddingsResponse`` containing the embeddings from the model.
     /// - Throws: An error if the request fails or the response can't be decoded.
     public func embeddings(data: OKEmbeddingsRequestData) async throws -> OKEmbeddingsResponse {
-        let request = try OKRouter.embeddings(data: data).asURLRequest()
-        
+        let request = try OKRouter.embeddings(data: data).asURLRequest(with: baseURL)
+
         return try await OKHTTPClient.shared.send(request: request, with: OKEmbeddingsResponse.self)
     }
 
@@ -49,7 +49,7 @@ extension OllamaKit {
     /// - Returns: A `AnyPublisher<OKEmbeddingsResponse, Error>` that emits embeddings.
     public func embeddings(data: OKEmbeddingsRequestData) -> AnyPublisher<OKEmbeddingsResponse, Error> {
         do {
-            let request = try OKRouter.embeddings(data: data).asURLRequest()
+            let request = try OKRouter.embeddings(data: data).asURLRequest(with: baseURL)
 
             return OKHTTPClient.shared.send(request: request, with: OKEmbeddingsResponse.self)
         } catch {

Sources/OllamaKit/OllamaKit+Generate.swift

@@ -32,8 +32,8 @@ extension OllamaKit {
     /// - Returns: An `AsyncThrowingStream<OKGenerateResponse, Error>` emitting the live stream of responses from the Ollama API.
     public func generate(data: OKGenerateRequestData) -> AsyncThrowingStream<OKGenerateResponse, Error> {
         do {
-            let request = try OKRouter.generate(data: data).asURLRequest()
-            
+            let request = try OKRouter.generate(data: data).asURLRequest(with: baseURL)
+
             return OKHTTPClient.shared.stream(request: request, with: OKGenerateResponse.self)
         } catch {
             return AsyncThrowingStream { continuation in
@@ -63,7 +63,7 @@ extension OllamaKit {
     /// - Returns: An `AnyPublisher<OKGenerateResponse, Error>` emitting the live stream of responses from the Ollama API.
     public func generate(data: OKGenerateRequestData) -> AnyPublisher<OKGenerateResponse, Error> {
         do {
-            let request = try OKRouter.generate(data: data).asURLRequest()
+            let request = try OKRouter.generate(data: data).asURLRequest(with: baseURL)
 
             return OKHTTPClient.shared.stream(request: request, with: OKGenerateResponse.self)
         } catch {

Sources/OllamaKit/OllamaKit+ModelInfo.swift

@@ -23,8 +23,8 @@ extension OllamaKit {
     /// - Returns: An ``OKModelInfoResponse`` containing detailed information about the model.
     /// - Throws: An error if the request fails or the response can't be decoded.
     public func modelInfo(data: OKModelInfoRequestData) async throws -> OKModelInfoResponse {
-        let request = try OKRouter.modelInfo(data: data).asURLRequest()
-        
+        let request = try OKRouter.modelInfo(data: data).asURLRequest(with: baseURL)
+
         return try await OKHTTPClient.shared.send(request: request, with: OKModelInfoResponse.self)
     }
 
@@ -49,7 +49,7 @@ extension OllamaKit {
     /// - Returns: A `AnyPublisher<OKModelInfoResponse, Error>` that emits detailed information about the model.
     public func modelInfo(data: OKModelInfoRequestData) -> AnyPublisher<OKModelInfoResponse, Error> {
         do {
-            let request = try OKRouter.modelInfo(data: data).asURLRequest()
+            let request = try OKRouter.modelInfo(data: data).asURLRequest(with: baseURL)
 
             return OKHTTPClient.shared.send(request: request, with: OKModelInfoResponse.self)
         } catch {

Sources/OllamaKit/OllamaKit+Models.swift

@@ -21,8 +21,8 @@ extension OllamaKit {
     /// - Returns: An ``OKModelResponse`` object listing the available models.
     /// - Throws: An error if the request fails or the response can't be decoded.
     public func models() async throws -> OKModelResponse {
-        let request = try OKRouter.models.asURLRequest()
-        
+        let request = try OKRouter.models.asURLRequest(with: baseURL)
+
         return try await OKHTTPClient.shared.send(request: request, with: OKModelResponse.self)
     }
 
@@ -45,7 +45,7 @@ extension OllamaKit {
     /// - Returns: A `AnyPublisher<OKModelResponse, Error>` that emits the list of available models.
     public func models() -> AnyPublisher<OKModelResponse, Error> {
         do {
-            let request = try OKRouter.models.asURLRequest()
+            let request = try OKRouter.models.asURLRequest(with: baseURL)
 
             return OKHTTPClient.shared.send(request: request, with: OKModelResponse.self)
         } catch {

Sources/OllamaKit/OllamaKit+PullModel.swift

@@ -31,7 +31,7 @@ extension OllamaKit {
     /// - Returns: An asynchronous stream that emits ``OKPullModelResponse``.
     public func pullModel(data: OKPullModelRequestData) -> AsyncThrowingStream<OKPullModelResponse, Error> {
         do {
-            let request = try OKRouter.pullModel(data: data).asURLRequest()
+            let request = try OKRouter.pullModel(data: data).asURLRequest(with: baseURL)
 
             return OKHTTPClient.shared.stream(request: request, with: OKPullModelResponse.self)
         } catch {
@@ -67,7 +67,7 @@ extension OllamaKit {
     /// - Returns: A combine publisher that emits ``OKPullModelResponse``.
     public func pullModel(data: OKPullModelRequestData) -> AnyPublisher<OKPullModelResponse, Error> {
         do {
-            let request = try OKRouter.pullModel(data: data).asURLRequest()
+            let request = try OKRouter.pullModel(data: data).asURLRequest(with: baseURL)
 
             return OKHTTPClient.shared.stream(request: request, with: OKPullModelResponse.self)
         } catch {

Sources/OllamaKit/OllamaKit+Reachable.swift

@@ -21,7 +21,7 @@ extension OllamaKit {
     /// - Returns: `true` if the Ollama API is reachable, `false` otherwise.
     public func reachable() async -> Bool {
         do {
-            let request = try OKRouter.root.asURLRequest()
+            let request = try OKRouter.root.asURLRequest(with: baseURL)
             try await OKHTTPClient.shared.send(request: request)
 
             return true
@@ -47,7 +47,7 @@ extension OllamaKit {
     /// - Returns: A `AnyPublisher<Bool, Never>` that emits `true` if the API is reachable, `false` otherwise.
     public func reachable() -> AnyPublisher<Bool, Never> {
         do {
-            let request = try OKRouter.root.asURLRequest()
+            let request = try OKRouter.root.asURLRequest(with: baseURL)
 
             return OKHTTPClient.shared.send(request: request)
                 .map { _ in true }

Sources/OllamaKit/OllamaKit.swift

@@ -8,20 +8,20 @@
 import Foundation
 
 /// Provides a streamlined way to access the Ollama API, encapsulating the complexities of network communication and data processing.
-public struct OllamaKit {
+public struct OllamaKit: Sendable {
     var router: OKRouter.Type
     var decoder: JSONDecoder = .default
-
+    var baseURL: URL
+
     /// Initializes a new instance of `OllamaKit` with the default base URL for the Ollama API.
     ///
     /// ```swift
     /// let ollamaKit = OllamaKit()
     /// ```
     public init() {
         let router = OKRouter.self
-        router.baseURL = URL(string: "http://localhost:11434")!
-
         self.router = router
+        self.baseURL = URL(string: "http://localhost:11434")!
     }
 
     /// Initializes a new instance of `OllamaKit` with a custom base URL for the Ollama API.
@@ -34,8 +34,7 @@ public struct OllamaKit {
     /// - Parameter baseURL: The base URL to use for API requests.
     public init(baseURL: URL) {
         let router = OKRouter.self
-        router.baseURL = baseURL
-
         self.router = router
+        self.baseURL = baseURL
     }
 }

Sources/OllamaKit/RequestData/Completion/OKCompletionOptions.swift

@@ -8,7 +8,7 @@
 import Foundation
 
 // A structure that encapsulates options for controlling the behavior of content generation in the Ollama API.
-public struct OKCompletionOptions: Encodable {
+public struct OKCompletionOptions: Encodable, Sendable {
     /// Optional integer to enable Mirostat sampling for controlling perplexity.
     /// (0 = disabled, 1 = Mirostat, 2 = Mirostat 2.0)
     /// Mirostat sampling helps regulate the unpredictability of the output,

Sources/OllamaKit/RequestData/OKChatRequestData.swift

@@ -8,7 +8,7 @@
 import Foundation
 
 /// A structure that encapsulates data for chat requests to the Ollama API.
-public struct OKChatRequestData {
+public struct OKChatRequestData: Sendable {
     private let stream: Bool
 
     /// A string representing the model identifier to be used for the chat session.
@@ -31,7 +31,7 @@ public struct OKChatRequestData {
     }
 
     /// A structure that represents a single message in the chat request.
-    public struct Message: Encodable {
+    public struct Message: Encodable, Sendable {
         /// A ``Role`` value indicating the sender of the message (system, assistant, user).
         public let role: Role
 
@@ -48,7 +48,7 @@ public struct OKChatRequestData {
         }
 
         /// An enumeration that represents the role of the message sender.
-        public enum Role: String, Encodable {
+        public enum Role: String, Encodable, Sendable {
             /// Indicates the message is from the system.
             case system
 

Sources/OllamaKit/RequestData/OKCopyModelRequestData.swift

@@ -8,7 +8,7 @@
 import Foundation
 
 /// A structure that encapsulates the necessary data to request a model copy operation in the Ollama API.
-public struct OKCopyModelRequestData: Encodable {
+public struct OKCopyModelRequestData: Encodable, Sendable {
     /// A string representing the identifier of the source model to be copied.
     public let source: String
 

Sources/OllamaKit/RequestData/OKDeleteModelRequestData.swift

@@ -8,7 +8,7 @@
 import Foundation
 
 /// A structure that encapsulates the necessary data to request a model deletion in the Ollama API.
-public struct OKDeleteModelRequestData: Encodable {
+public struct OKDeleteModelRequestData: Encodable, Sendable {
     /// A string representing the identifier of the model to be deleted.
     public let name: String
 

Sources/OllamaKit/RequestData/OKEmbeddingsRequestData.swift

@@ -8,7 +8,7 @@
 import Foundation
 
 /// A structure that encapsulates the data required for generating embeddings using the Ollama API.
-public struct OKEmbeddingsRequestData: Encodable {
+public struct OKEmbeddingsRequestData: Encodable, Sendable {
     /// A string representing the identifier of the model.
     public let model: String
 

Sources/OllamaKit/RequestData/OKGenerateRequestData.swift

@@ -8,7 +8,7 @@
 import Foundation
 
 /// A structure that encapsulates the data required for generating responses using the Ollama API.
-public struct OKGenerateRequestData {
+public struct OKGenerateRequestData: Sendable {
     private let stream: Bool
 
     /// A string representing the identifier of the model.

Sources/OllamaKit/RequestData/OKModelInfoRequestData.swift

@@ -8,7 +8,7 @@
 import Foundation
 
 /// A structure that encapsulates the data necessary for requesting information about a specific model from the Ollama API.
-public struct OKModelInfoRequestData: Encodable {
+public struct OKModelInfoRequestData: Encodable, Sendable {
     /// A string representing the identifier of the model for which information is requested.
     public let name: String