react-native-nitro-auth 0.1.2 → 0.1.3

package/README.md

@@ -1,26 +1,34 @@
 # react-native-nitro-auth
 
-🔐 **The fastest authentication library for React Native** — Google & Apple Sign-In with native C++/JSI performance. No bridge overhead. Full feature parity across iOS, Android, and Web.
+🚀 **High-performance, JSI-powered Authentication for React Native.**
 
-[![npm](https://img.shields.io/npm/v/react-native-nitro-auth)](https://www.npmjs.com/package/react-native-nitro-auth)
-[![license](https://img.shields.io/npm/l/react-native-nitro-auth)](LICENSE)
+Nitro Auth is a modern authentication library for React Native built on top of [Nitro Modules](https://github.com/mrousavy/nitro). It provides a unified, type-safe API for Google and Apple Sign-In with zero-bridge overhead.
 
-## Why react-native-nitro-auth?
+## Why Nitro Auth?
 
-- ⚡ **Zero bridge overhead** — Built on [Nitro Modules](https://github.com/mrousavy/nitro) (C++/JSI), authentication calls are synchronous where possible
-- 🔐 **Google & Apple Sign-In** — Production-ready implementation for iOS, Android, and Web
-- 📦 **Session persistence** — Users stay logged in across app restarts automatically
-- 🎯 **Custom OAuth scopes** — Request only the permissions you need
-- 🔄 **Incremental authorization** — Add scopes later without re-authentication
-- 🔑 **Predictable Error Handling** — Standardized error codes across all platforms
-- 🔁 **Automatic Token Refresh** — Seamlessly handles background token rotation
-- 🎨 **Ready-to-use UI** — Pre-built `SocialButton` with loading states
-- 📱 **Expo & bare RN** — Works with both, config plugin included
+Nitro Auth is designed to replace legacy modules like `@react-native-google-signin/google-signin` with a modern, high-performance architecture.
+
+| Feature | Legacy Modules | Nitro Auth |
+| :--- | :--- | :--- |
+| **Performance** | Async bridge overhead (JSON) | **Direct JSI C++ (Zero-copy)** |
+| **Persistence** | Varies / Manual | **Built-in & Automatic** |
+| **Setup** | Manual async initialization | **Sync & declarative plugins** |
+| **Types** | Manual / Brittle | **Fully Generated (Nitrogen)** |
+
+## Features
+
+- 🏎️ **Ultra-fast**: Direct C++ calls using JSI (no JSON serialization).
+- 🛡️ **Fully Type-Safe**: Shared types between TypeScript, C++, Swift, and Kotlin.
+- �� **Incremental Auth**: Request additional OAuth scopes on the fly.
+- 📦 **Expo Ready**: Comes with a powerful Config Plugin for zero-config setup.
+- 📱 **Cross-Platform**: Unified API for iOS, Android, and Web.
+- 🔁 **Auto-Refresh**: Synchronous access to tokens with automatic silent refresh.
 
 ## Installation
 
 ```bash
-npm install react-native-nitro-auth react-native-nitro-modules
+bun add react-native-nitro-auth react-native-nitro-modules
+bun prebuild
 ```
 
 ### Expo Setup
@@ -36,6 +44,7 @@ Add the plugin to `app.json`:
         {
           "ios": {
             "googleClientId": "YOUR_IOS_CLIENT_ID.apps.googleusercontent.com",
+            "googleServerClientId": "YOUR_WEB_CLIENT_ID.apps.googleusercontent.com",
             "googleUrlScheme": "com.googleusercontent.apps.YOUR_IOS_CLIENT_ID"
           },
           "android": {
@@ -43,24 +52,17 @@ Add the plugin to `app.json`:
           }
         }
       ]
-    ],
-    "extra": {
-      "googleWebClientId": "YOUR_WEB_CLIENT_ID.apps.googleusercontent.com",
-      "appleWebClientId": "com.yourcompany.yourapp.service"
-    }
+    ]
   }
 }
 ```
 
-Then run:
-
-```bash
-npx expo prebuild
-```
+> [!NOTE]
+> `googleServerClientId` is only required if you need a `serverAuthCode` for backend integration.
 
 ### Bare React Native
 
-**iOS:** Add `GIDClientID` to `Info.plist` and enable "Sign in with Apple" capability.
+**iOS:** Add `GIDClientID` (and optionally `GIDServerClientID`) to `Info.plist` and enable "Sign in with Apple" capability.
 
 **Android:** Add `nitro_auth_google_client_id` string resource in `res/values/strings.xml`.
 
@@ -220,31 +222,6 @@ if (user?.serverAuthCode) {
 | Auto-Refresh              | ✅  | ✅      | ✅  |
 | Native C++ Performance    | ✅  | ✅      | —   |
 
-## Troubleshooting
-
-### Common Issues
-
-- **`configuration_error`**: This usually means the `googleClientId` or `GIDClientID` is missing from your native configuration. Double-check your `app.json` or `Info.plist`/`strings.xml`.
-- **`cancelled`**: The user manually closed the sign-in modal. This is expected behavior and should be handled by your UI.
-- **Android Popup not appearing**: Ensure you have configured the correct SHA-1 fingerprint in the Google Cloud Console for your Android app.
-- **Web Popup blocked**: Browsers may block popups if they aren't triggered by a user gesture. Ensure `login()` is called directly from an `onPress` or `onClick` handler.
-
-### Checking Setup Status
-
-On Android, you can use `hasPlayServices` to check if the device supports Google Sign-In before showing the button.
-
-## Testing & Example App
-
-The monorepo includes a full-featured example app in `apps/example`.
-
-### Running the Example
-
-1. **Install dependencies**: `bun install`
-2. **Configure Client IDs**: Update `apps/example/app.json` with your Google/Apple credentials.
-3. **Run on iOS**: `npm run example:ios`
-4. **Run on Android**: `npm run example:android`
-5. **Run on Web**: `npm run start -- --web`
-
 ## Architecture
 
 `react-native-nitro-auth` is built using [Nitro Modules](https://github.com/mrousavy/nitro). Unlike traditional React Native modules, Nitro uses JSI to provide:

package/android/build.gradle

@@ -63,6 +63,7 @@ android {
 
   buildFeatures {
     buildConfig true
+    consumerProguardFiles "proguard-rules.pro"
     prefab true
   }
 

package/android/proguard-rules.pro

@@ -0,0 +1,4 @@
+# Nitro Auth Proguard Rules
+-keep class com.auth.** { *; }
+-keep class com.margelo.nitro.com.auth.** { *; }
+-keep class com.google.android.gms.auth.api.signin.** { *; }

package/app.plugin.js

@@ -63,5 +63,5 @@ const withNitroAuth = (config, props = {}) => {
 module.exports = createRunOncePlugin(
   withNitroAuth,
   "react-native-nitro-auth",
-  "0.1.2"
+  "0.1.3"
 );

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-nitro-auth",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "High-performance authentication library for React Native with Google Sign-In and Apple Sign-In support, powered by Nitro Modules (JSI)",
   "main": "lib/commonjs/index.js",
   "module": "lib/module/index.js",