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

package/README.md

@@ -32,15 +32,8 @@ This allows your Capacitor app to use Clerk's native iOS/Android SDKs (following
 
 ## Installation
 
-### From GitHub Packages (Recommended)
+### From npm (Recommended)
 
-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
-```
-
-2. Install the package:
 ```bash
 npm install @trainon-inc/capacitor-clerk-native
 # or
@@ -49,15 +42,23 @@ pnpm add @trainon-inc/capacitor-clerk-native
 yarn add @trainon-inc/capacitor-clerk-native
 ```
 
-> **Note**: You'll need a GitHub Personal Access Token with `read:packages` permission. [Create one here](https://github.com/settings/tokens/new?scopes=read:packages)
+### From GitHub Packages
 
-### From NPM (Future)
+Alternatively, install from GitHub Packages:
 
-Once published to npm:
+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
+```
+
+2. Install the package:
 ```bash
-npm install capacitor-clerk-native
+npm install @trainon-inc/capacitor-clerk-native
 ```
 
+> **Note**: You'll need a GitHub Personal Access Token with `read:packages` permission. [Create one here](https://github.com/settings/tokens/new?scopes=read:packages)
+
 ## iOS Setup
 
 ### Prerequisites
@@ -315,6 +316,8 @@ function Profile() {
 
 ## Architecture
 
+### iOS Architecture (Bridge Pattern)
+
 ```
 ┌─────────────────────────────────────────────────┐
 │  JavaScript/React (Capacitor WebView)           │
@@ -336,6 +339,22 @@ function Profile() {
 └─────────────────────────────────────────────────┘
 ```
 
+### Android Architecture
+
+```
+┌─────────────────────────────────────────────────┐
+│  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         │
+└─────────────────────────────────────────────────┘
+```
+
 ## API
 
 ### Methods
@@ -393,9 +412,83 @@ function Profile() {
 - 💬 [Clerk Discord Community](https://clerk.com/discord)
 - 🐛 [Report Issues](https://github.com/TrainOn-Inc/capacitor-clerk-native/issues)
 
-## Android Support
+## 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.
+
+### 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+
+
+### 1. Sync Capacitor
+
+After installing the plugin, sync your Android project:
+
+```bash
+npx cap sync android
+```
+
+This will:
+- Add the plugin to `capacitor.settings.gradle`
+- Add the plugin dependency to `capacitor.build.gradle`
+
+### 2. Plugin Structure
+
+The plugin includes:
+
+```
+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
+
+- **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.
+
+### Troubleshooting Android
+
+#### "No matching variant" error
+```
+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:
+```bash
+npm update @trainon-inc/capacitor-clerk-native
+npx cap sync android
+```
+
+#### Gradle sync fails
+- Clean the project: **Build → Clean Project**
+- Invalidate caches: **File → Invalidate Caches / Restart**
+- Delete `.gradle` folder and re-sync
 
-Android support is planned. The bridge pattern will work similarly with Gradle and the Clerk Android SDK.
+#### 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
 
@@ -411,7 +504,6 @@ Created by the TrainOn Team to solve CocoaPods ↔ SPM conflicts when integratin
 
 ## Support
 
-- [GitHub Issues](https://github.com/Trainon-Inc/capacitor-clerk-native/issues)
+- [GitHub Issues](https://github.com/TrainOn-Inc/capacitor-clerk-native/issues)
 - [Clerk Documentation](https://clerk.com/docs)
 - [Capacitor Documentation](https://capacitorjs.com/docs)
-# Test CI/CD for npm publishing

package/android/build.gradle

@@ -0,0 +1,57 @@
+ext {
+    junitVersion = project.hasProperty('junitVersion') ? rootProject.ext.junitVersion : '4.13.2'
+    androidxAppCompatVersion = project.hasProperty('androidxAppCompatVersion') ? rootProject.ext.androidxAppCompatVersion : '1.7.0'
+    androidxJunitVersion = project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.2.1'
+    androidxEspressoCoreVersion = project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.6.1'
+}
+
+buildscript {
+    repositories {
+        google()
+        mavenCentral()
+    }
+    dependencies {
+        classpath 'com.android.tools.build:gradle:8.7.2'
+    }
+}
+
+apply plugin: 'com.android.library'
+
+android {
+    namespace "com.trainon.capacitor.clerk"
+    compileSdk project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 35
+    defaultConfig {
+        minSdkVersion project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 23
+        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 35
+        versionCode 1
+        versionName "1.0"
+        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
+    }
+    buildTypes {
+        release {
+            minifyEnabled false
+            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
+        }
+    }
+    lintOptions {
+        abortOnError false
+    }
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_21
+        targetCompatibility JavaVersion.VERSION_21
+    }
+}
+
+repositories {
+    google()
+    mavenCentral()
+}
+
+dependencies {
+    implementation fileTree(dir: 'libs', include: ['*.jar'])
+    implementation project(':capacitor-android')
+    implementation "androidx.appcompat:appcompat:$androidxAppCompatVersion"
+    testImplementation "junit:junit:$junitVersion"
+    androidTestImplementation "androidx.test.ext:junit:$androidxJunitVersion"
+    androidTestImplementation "androidx.test.espresso:espresso-core:$androidxEspressoCoreVersion"
+}

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1,2 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+</manifest>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trainon-inc/capacitor-clerk-native",
-  "version": "1.14.0",
+  "version": "1.21.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",
@@ -18,6 +18,7 @@
   "files": [
     "android/src/main/",
     "android/build.gradle",
+    "android/src/main/AndroidManifest.xml",
     "dist/",
     "ios/Plugin/",
     "TrainonIncCapacitorClerkNative.podspec",