feat: conforms to Sendable (#4)

* feat: conforms to `Sendable` * update machine to macOS 15
kevinhermawan · Oct 27, 2024 · 5b42916 · 5b42916
1 parent 585de82
commit 5b42916
Show file tree

Hide file tree

Showing 8 changed files with 29 additions and 9 deletions.
diff --git a/.github/workflows/code-quality.yml b/.github/workflows/code-quality.yml
@@ -10,16 +10,16 @@ on:
 
 jobs:
   test-ios:
-    runs-on: macos-14
+    runs-on: macos-15
 
     steps:
       - uses: actions/checkout@v4
 
       - name: Build and test
-        run: xcodebuild test -scheme AIModelRetriever -destination 'platform=iOS Simulator,name=iPhone 15 Pro'
+        run: xcodebuild test -scheme AIModelRetriever -destination 'platform=iOS Simulator,name=iPhone 16 Pro'
 
   test-macos:
-    runs-on: macos-14
+    runs-on: macos-15
 
     steps:
       - uses: actions/checkout@v4

diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml
@@ -15,7 +15,7 @@ concurrency:
 
 jobs:
   deploy:
-    runs-on: macos-14
+    runs-on: macos-15
 
     environment:
       name: github-pages

diff --git a/Playground/Playground.xcodeproj/project.pbxproj b/Playground/Playground.xcodeproj/project.pbxproj
@@ -277,7 +277,7 @@
 				PRODUCT_BUNDLE_IDENTIFIER = "ai.hermawan.swift-ai-model-retriever.Playground";
 				PRODUCT_NAME = "$(TARGET_NAME)";
 				SWIFT_EMIT_LOC_STRINGS = YES;
-				SWIFT_VERSION = 5.0;
+				SWIFT_VERSION = 6.0;
 				TARGETED_DEVICE_FAMILY = "1,2";
 			};
 			name = Debug;
@@ -306,7 +306,7 @@
 				PRODUCT_BUNDLE_IDENTIFIER = "ai.hermawan.swift-ai-model-retriever.Playground";
 				PRODUCT_NAME = "$(TARGET_NAME)";
 				SWIFT_EMIT_LOC_STRINGS = YES;
-				SWIFT_VERSION = 5.0;
+				SWIFT_VERSION = 6.0;
 				TARGETED_DEVICE_FAMILY = "1,2";
 			};
 			name = Release;

diff --git a/README.md b/README.md
@@ -59,6 +59,16 @@ for model in models {
 
 > Note: The Anthropic models are hardcoded. They do not require an API call to retrieve.
 
+### Retrieving Cohere Models
+
+```swift
+let models = modelRetriever.cohere(apiKey: "your-cohere-api-key")
+
+for model in models {
+    print("Model ID: \(model.id), Name: \(model.name)")
+}
+```
+
 ### Retrieving Google Models
 
 ```swift

diff --git a/Sources/AIModelRetriever/AIModel.swift b/Sources/AIModelRetriever/AIModel.swift
@@ -8,7 +8,7 @@
 import Foundation
 
 /// A struct that represents an AI model.
-public struct AIModel: Identifiable {
+public struct AIModel: Identifiable, Sendable {
     /// The unique identifier of the model.
     public let id: String
 

diff --git a/Sources/AIModelRetriever/AIModelRetriever.swift b/Sources/AIModelRetriever/AIModelRetriever.swift
@@ -11,7 +11,7 @@ import FoundationNetworking
 #endif
 
 /// A struct that retrieves AI models from various providers.
-public struct AIModelRetriever {
+public struct AIModelRetriever: Sendable {
     /// Initializes a new instance of ``AIModelRetriever``.
     public init() {}
 

diff --git a/Sources/AIModelRetriever/AIModelRetrieverError.swift b/Sources/AIModelRetriever/AIModelRetrieverError.swift
@@ -8,7 +8,7 @@
 import Foundation
 
 /// An enum that represents errors that can occur during AI model retrieval.
-public enum AIModelRetrieverError: Error {
+public enum AIModelRetrieverError: Error, Sendable {
     /// Indicates that the server response was not in the expected format.
     case badServerResponse
 

diff --git a/Sources/AIModelRetriever/Documentation.docc/Documentation.md b/Sources/AIModelRetriever/Documentation.docc/Documentation.md
@@ -30,6 +30,16 @@ for model in models {
 
 > Note: The Anthropic models are hardcoded. They do not require an API call to retrieve.
 
+### Retrieving Cohere Models
+
+```swift
+let models = modelRetriever.cohere(apiKey: "your-cohere-api-key")
+
+for model in models {
+    print("Model ID: \(model.id), Name: \(model.name)")
+}
+```
+
 ### Retrieving Google Models
 
 ```swift