@trainon-inc/capacitor-clerk-native 1.21.0 → 1.23.0

package/README.md

@@ -49,7 +49,7 @@ Alternatively, install from GitHub Packages:
 1. Create a `.npmrc` file in your project root:
 ```
 @trainon-inc:registry=https://npm.pkg.github.com
-//npm.pkg.github.com/:_authToken= YOUR_GITHUB_TOKEN
+//npm.pkg.github.com/:_authToken=YOUR_GITHUB_TOKEN
 ```
 
 2. Install the package:
@@ -339,19 +339,21 @@ function Profile() {
 └─────────────────────────────────────────────────┘
 ```
 
-### Android Architecture
+### Android Architecture (Web Provider)
 
 ```
 ┌─────────────────────────────────────────────────┐
 │  JavaScript/React (Capacitor WebView)           │
-│  - Uses capacitor-clerk-native hooks            │
-└─────────────────┬───────────────────────────────┘
-                  │ Capacitor Bridge
-┌─────────────────▼───────────────────────────────┐
-│  ClerkNativePlugin (Gradle Module)              │
-│  - Android library module                       │
-│  - Receives calls from JavaScript               │
-│  - Can integrate with Clerk Android SDK         │
+│  - Uses @clerk/clerk-react (web provider)       │
+│  - Full Clerk functionality via web SDK         │
+└─────────────────────────────────────────────────┘
+         (No native plugin needed for auth)
+
+┌─────────────────────────────────────────────────┐
+│  ClerkNativePlugin (Gradle Module) - Stub       │
+│  - Exists for Capacitor plugin registration     │
+│  - Returns "use web provider" for all methods   │
+│  - No native Clerk SDK dependency               │
 └─────────────────────────────────────────────────┘
 ```
 
@@ -414,59 +416,53 @@ function Profile() {
 
 ## Android Setup
 
-Android is supported using the same bridge pattern as iOS. The plugin provides a stub implementation that you can extend with the Clerk Android SDK.
+**Important**: On Android, this plugin provides a stub implementation. Android WebViews work well with web-based authentication (unlike iOS which has cookie issues), so **Android should use the web Clerk provider (`@clerk/clerk-react`)** instead of the native plugin.
 
-### Prerequisites
-
-- ✅ A [Clerk account](https://dashboard.clerk.com/sign-up)
-- ✅ A Clerk application set up in the dashboard
-- ✅ Android Studio with Gradle 8.7+ and AGP 8.5+
+### Why Web Provider for Android?
 
-### 1. Sync Capacitor
-
-After installing the plugin, sync your Android project:
-
-```bash
-npx cap sync android
-```
+- ✅ Android WebViews handle cookies correctly - no authentication issues
+- ✅ The Clerk Android SDK is still in early stages (v0.1.x) with evolving APIs
+- ✅ Using `@clerk/clerk-react` provides a stable, well-tested experience
+- ✅ Simpler setup - no native configuration required
 
-This will:
-- Add the plugin to `capacitor.settings.gradle`
-- Add the plugin dependency to `capacitor.build.gradle`
+### Recommended App Setup
 
-### 2. Plugin Structure
+Configure your app to use the native plugin only on iOS:
 
-The plugin includes:
+```typescript
+import { Capacitor } from "@capacitor/core";
+import { ClerkProvider as WebClerkProvider } from "@clerk/clerk-react";
+import { ClerkProvider as NativeClerkProvider } from "@trainon-inc/capacitor-clerk-native";
+
+// Use native Clerk only on iOS (due to WebView cookie issues)
+// Android WebViews work fine with web Clerk
+const isIOS = Capacitor.getPlatform() === "ios";
+const ClerkProvider = isIOS ? NativeClerkProvider : WebClerkProvider;
+
+export function App() {
+  const clerkProps = isIOS
+    ? { publishableKey: "pk_test_..." }
+    : {
+        publishableKey: "pk_test_...",
+        signInFallbackRedirectUrl: "/home",
+        signUpFallbackRedirectUrl: "/home",
+      };
 
+  return (
+    <ClerkProvider {...clerkProps}>
+      <YourApp />
+    </ClerkProvider>
+  );
+}
 ```
-android/
-├── build.gradle              # Gradle build configuration
-└── src/
-    └── main/
-        ├── AndroidManifest.xml   # Android manifest
-        └── java/
-            └── com/trainon/capacitor/clerk/
-                └── ClerkNativePlugin.java
-```
-
-### 3. Gradle Configuration
-
-The plugin uses these default configurations (which can be overridden by your app's `variables.gradle`):
-
-| Property | Default | Description |
-|----------|---------|-------------|
-| `compileSdkVersion` | 35 | Android compile SDK |
-| `minSdkVersion` | 23 | Minimum Android version |
-| `targetSdkVersion` | 35 | Target Android version |
-| `junitVersion` | 4.13.2 | JUnit test version |
 
-### 4. Build Requirements
+### Build Requirements
 
 - **Gradle**: 8.11.1+
-- **Android Gradle Plugin**: 8.7.2+
-- **Java**: 21
-
-These are configured in the plugin's `build.gradle` and are compatible with Capacitor 7.
+- **Android Gradle Plugin**: 8.5.0+
+- **Java**: 17+
+- **Min SDK**: 23 (Android 6.0)
+- **Target SDK**: 35 (Android 15)
 
 ### Troubleshooting Android
 
@@ -476,20 +472,21 @@ Could not resolve project :trainon-inc-capacitor-clerk-native
 No matching variant of project was found. No variants exist.
 ```
 
-**Solution**: Ensure you have the latest version of the plugin (1.16.0+) which includes the required `build.gradle` and `AndroidManifest.xml` files. Run:
+**Solution**: Update to the latest plugin version:
 ```bash
 npm update @trainon-inc/capacitor-clerk-native
 npx cap sync android
 ```
 
+#### "invalid source release: 21" error
+The plugin uses Java 17. Ensure your Android Studio uses JDK 17+:
+- **File → Project Structure → SDK Location → Gradle JDK** → Select JDK 17+
+
 #### Gradle sync fails
 - Clean the project: **Build → Clean Project**
 - Invalidate caches: **File → Invalidate Caches / Restart**
 - Delete `.gradle` folder and re-sync
 
-#### AGP version mismatch
-If you see AGP version conflicts, ensure your app's `build.gradle` uses AGP 8.5.0 or higher, matching the plugin's requirements.
-
 ## Contributing
 
 Contributions are welcome! This plugin was created to solve a real problem we encountered, and we'd love to make it better.

package/android/build.gradle

@@ -37,8 +37,8 @@ android {
         abortOnError false
     }
     compileOptions {
-        sourceCompatibility JavaVersion.VERSION_21
-        targetCompatibility JavaVersion.VERSION_21
+        sourceCompatibility JavaVersion.VERSION_17
+        targetCompatibility JavaVersion.VERSION_17
     }
 }
 

package/android/src/main/AndroidManifest.xml

@@ -1,2 +1,3 @@
 <manifest xmlns:android="http://schemas.android.com/apk/res/android">
+    <uses-permission android:name="android.permission.INTERNET" />
 </manifest>

package/android/src/main/java/com/trainon/capacitor/clerk/ClerkNativePlugin.java

@@ -5,77 +5,88 @@ import com.getcapacitor.PluginCall;
 import com.getcapacitor.PluginMethod;
 import com.getcapacitor.annotation.CapacitorPlugin;
 
+/**
+ * Android stub for Clerk Native plugin.
+ * 
+ * On Android, authentication is handled by the web Clerk provider (@clerk/clerk-react)
+ * because Android WebViews work well with web-based auth (unlike iOS which has cookie issues).
+ * 
+ * This plugin exists to satisfy Capacitor's plugin registration but all methods
+ * will return errors indicating to use the web provider instead.
+ */
 @CapacitorPlugin(name = "ClerkNative")
 public class ClerkNativePlugin extends Plugin {
 
+    private static final String USE_WEB_MESSAGE = "Android uses web Clerk provider. Configure your app to use @clerk/clerk-react on Android.";
+
     @PluginMethod
     public void configure(PluginCall call) {
-        call.reject("Android not yet implemented");
+        // Allow configure to succeed silently - the web provider will handle auth
+        call.resolve();
     }
 
     @PluginMethod
     public void load(PluginCall call) {
-        call.reject("Android not yet implemented");
+        call.reject(USE_WEB_MESSAGE);
     }
 
     @PluginMethod
     public void signInWithEmail(PluginCall call) {
-        call.reject("Android not yet implemented");
+        call.reject(USE_WEB_MESSAGE);
     }
 
     @PluginMethod
     public void verifyEmailCode(PluginCall call) {
-        call.reject("Android not yet implemented");
+        call.reject(USE_WEB_MESSAGE);
     }
 
     @PluginMethod
     public void signInWithPassword(PluginCall call) {
-        call.reject("Android not yet implemented");
+        call.reject(USE_WEB_MESSAGE);
     }
 
     @PluginMethod
     public void signUp(PluginCall call) {
-        call.reject("Android not yet implemented");
+        call.reject(USE_WEB_MESSAGE);
     }
 
     @PluginMethod
     public void verifySignUpEmail(PluginCall call) {
-        call.reject("Android not yet implemented");
+        call.reject(USE_WEB_MESSAGE);
     }
 
     @PluginMethod
     public void getUser(PluginCall call) {
-        call.reject("Android not yet implemented");
+        call.reject(USE_WEB_MESSAGE);
     }
 
     @PluginMethod
     public void getToken(PluginCall call) {
-        call.reject("Android not yet implemented");
+        call.reject(USE_WEB_MESSAGE);
     }
 
     @PluginMethod
     public void signOut(PluginCall call) {
-        call.reject("Android not yet implemented");
+        call.reject(USE_WEB_MESSAGE);
     }
 
     @PluginMethod
     public void updateUser(PluginCall call) {
-        call.reject("Android not yet implemented");
+        call.reject(USE_WEB_MESSAGE);
     }
 
     @PluginMethod
     public void requestPasswordReset(PluginCall call) {
-        call.reject("Android not yet implemented");
+        call.reject(USE_WEB_MESSAGE);
     }
 
     @PluginMethod
     public void resetPassword(PluginCall call) {
-        call.reject("Android not yet implemented");
+        call.reject(USE_WEB_MESSAGE);
     }
 
     @PluginMethod
     public void refreshSession(PluginCall call) {
-        call.reject("Android not yet implemented");
+        call.reject(USE_WEB_MESSAGE);
     }
 }
-

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trainon-inc/capacitor-clerk-native",
-  "version": "1.21.0",
+  "version": "1.23.0",
   "description": "Capacitor plugin for Clerk native authentication using bridge pattern to integrate Clerk iOS/Android SDKs with CocoaPods/Gradle",
   "main": "dist/index.js",
   "module": "dist/index.js",