@capgo/capacitor-llm 8.0.12 → 8.0.14

package/README.md

@@ -1,6 +1,6 @@
 # @capgo/capacitor-llm
 
-<a href="https://capgo.app/"><img src='https://raw.githubusercontent.com/Cap-go/capgo/main/assets/capgo_banner.png' alt='Capgo - Instant updates for capacitor'/></a>
+<a href="https://capgo.app/"><img src="https://capgo.app/readme-banner.svg?repo=Cap-go/capacitor-llm" alt="Capgo - Instant updates for Capacitor" /></a>
 
 <div align="center">
   <h2><a href="https://capgo.app/?ref=plugin_llm"> ➡️ Get Instant updates for your App with Capgo 🚀</a></h2>
@@ -37,11 +37,13 @@ bunx cap sync
 
 ### iOS Additional Setup for Custom Models
 
-Apple Intelligence works without bundled model files on supported iOS versions. For custom models, the plugin supports MediaPipe through CocoaPods and ExecuTorch through Swift Package Manager.
+Apple Intelligence works without bundled model files on supported iOS versions. For custom models, the plugin supports MediaPipe through CocoaPods and ExecuTorch when the host app links ExecuTorch with Swift Package Manager. The plugin package remains iOS 15 compatible; iOS ExecuTorch requires an iOS 17 or newer app target because ExecuTorch requires iOS 17.
 
 **Using CocoaPods:**
 The MediaPipe dependencies are already configured in the podspec. Make sure to run `pod install` after adding the plugin.
 
+ExecuTorch is not provided by the CocoaPods integration. CocoaPods installs MediaPipe only. CocoaPods builds reject `engine: 'executorch'` with a clear runtime error unless the app also links ExecuTorch separately.
+
 **Note about Static Framework Warning:**
 When running `pod install`, you may see a warning about transitive dependencies with statically linked binaries. To fix this, update your Podfile:
 
@@ -73,7 +75,17 @@ end
 ```
 
 **Using Swift Package Manager:**
-The main Swift package stays compatible with iOS 15. To use ExecuTorch `.pte` models on iOS, add the ExecuTorch Swift package to your app target and link `executorch_llm`, `backend_xnnpack`, `kernels_llm`, `kernels_optimized`, `kernels_quantized`, and `kernels_torchao`. ExecuTorch currently requires iOS 17 or newer in the app target that links it. MediaPipe GenAI still does not officially support SPM, so use CocoaPods for MediaPipe `.task` models.
+The plugin's `Package.swift` does not link ExecuTorch directly because that would force every Swift Package Manager user onto iOS 17 or newer, even when they only use Apple Intelligence or MediaPipe.
+
+To use ExecuTorch on iOS, add it to your app target:
+
+1. Set the app target deployment version to iOS 17 or newer.
+2. In Xcode, open the app project, select **Package Dependencies**, and add `https://github.com/pytorch/executorch.git`.
+3. Use the `swiftpm-1.2.0` branch, or the ExecuTorch branch that matches the runtime version you want.
+4. Add these products to the app target: `executorch_llm`, `backend_xnnpack`, `kernels_llm`, `kernels_optimized`, `kernels_quantized`, and `kernels_torchao`.
+5. Add the `.pte` model and tokenizer file to the app target's Copy Bundle Resources, or download them at runtime.
+
+If those ExecuTorch products are not linked into the app target, `setModel({ engine: 'executorch' })` rejects with a clear runtime error. MediaPipe GenAI still does not officially support SPM, so use CocoaPods for MediaPipe `.task` models.
 
 ## Adding a Model to Your App
 
@@ -81,7 +93,7 @@ The simplest cross-platform custom model path is ExecuTorch. It uses the same ki
 
 ### ExecuTorch Models (iOS and Android)
 
-iOS uses ExecuTorch when the app target links the ExecuTorch SwiftPM products. Android uses the ExecuTorch Maven package.
+iOS uses ExecuTorch only when the host app links the ExecuTorch Swift Package products. It is not included by CocoaPods or by the plugin's `Package.swift`, so an app without those products can use Apple Intelligence or MediaPipe but will refuse `engine: 'executorch'`. Android uses the ExecuTorch Maven package.
 
 Bundle the model files:
 

package/android/src/main/java/ee/forgr/capgo_llm/LLMPlugin.java

@@ -12,7 +12,7 @@ import java.util.List;
 @CapacitorPlugin(name = "CapgoLLM")
 public class LLMPlugin extends Plugin {
 
-    private final String pluginVersion = "8.0.12";
+    private final String pluginVersion = "8.0.14";
 
     private LLM llm;
 

package/ios/Sources/LLMPlugin/LLMPlugin.swift

@@ -18,7 +18,7 @@ import MediaPipeTasksGenAI
 
 @objc(LLMPlugin)
 public class LLMPlugin: CAPPlugin, CAPBridgedPlugin {
-    private let pluginVersion: String = "8.0.12"
+    private let pluginVersion: String = "8.0.14"
     #if targetEnvironment(macCatalyst)
     private let catalystNotSupportedMessage = "CapgoLLM is not available on Mac Catalyst. Use an iOS/iPadOS target instead."
     #endif
@@ -78,6 +78,9 @@ public class LLMPlugin: CAPPlugin, CAPBridgedPlugin {
     private var execuTorchRunner: DynamicExecuTorchRunner?
     private var execuTorchChats: [String: ExecuTorchChatSession] = [:]
     private let execuTorchGenerationLock = NSLock()
+    private let execuTorchNotLinkedMessage = "ExecuTorch is not linked in this iOS app. " +
+        "It is not installed by CocoaPods; add the ExecuTorch Swift Package products " +
+        "to the app target on iOS 17+ or choose another engine."
     private var execuTorchIsGenerating = false
 
     @objc func setModel(_ call: CAPPluginCall) {
@@ -257,7 +260,9 @@ public class LLMPlugin: CAPPlugin, CAPBridgedPlugin {
         }
 
         guard DynamicExecuTorchRunner.isAvailable else {
-            call.reject("ExecuTorch is not linked in this iOS app. Add the ExecuTorch Swift Package products to the app target.")
+            isReady = false
+            notifyListeners("readinessChange", data: ["readiness": execuTorchNotLinkedMessage])
+            call.reject(execuTorchNotLinkedMessage)
             return
         }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capgo/capacitor-llm",
-  "version": "8.0.12",
+  "version": "8.0.14",
   "description": "Adds support for LLM locally runned for Capacitor",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",