react-native-nitro-auth 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 João Paulo C. Marra
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,254 @@
+# 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.
+
+[![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)
+
+## Why react-native-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
+
+## Installation
+
+```bash
+npm install react-native-nitro-auth react-native-nitro-modules
+```
+
+### Expo Setup
+
+Add the plugin to `app.json`:
+
+```json
+{
+  "expo": {
+    "plugins": [
+      [
+        "react-native-nitro-auth",
+        {
+          "ios": {
+            "googleClientId": "YOUR_IOS_CLIENT_ID.apps.googleusercontent.com",
+            "googleUrlScheme": "com.googleusercontent.apps.YOUR_IOS_CLIENT_ID"
+          },
+          "android": {
+            "googleClientId": "YOUR_ANDROID_CLIENT_ID.apps.googleusercontent.com"
+          }
+        }
+      ]
+    ],
+    "extra": {
+      "googleWebClientId": "YOUR_WEB_CLIENT_ID.apps.googleusercontent.com",
+      "appleWebClientId": "com.yourcompany.yourapp.service"
+    }
+  }
+}
+```
+
+Then run:
+
+```bash
+npx expo prebuild
+```
+
+### Bare React Native
+
+**iOS:** Add `GIDClientID` to `Info.plist` and enable "Sign in with Apple" capability.
+
+**Android:** Add `nitro_auth_google_client_id` string resource in `res/values/strings.xml`.
+
+## Quick Start
+
+### Using the Hook
+
+```tsx
+import { useAuth, SocialButton } from "react-native-nitro-auth";
+
+function LoginScreen() {
+  const { user, loading, error, login, logout, hasPlayServices } = useAuth();
+
+  if (user) {
+    return (
+      <View>
+        <Image source={{ uri: user.photo }} />
+        <Text>{user.name}</Text>
+        <Button title="Sign Out" onPress={logout} />
+      </View>
+    );
+  }
+
+  return (
+    <View>
+      {error && <Text style={{ color: "red" }}>{error.message}</Text>}
+      {!hasPlayServices && <Text>Please install Google Play Services</Text>}
+
+      <SocialButton
+        provider="google"
+        onPress={() => login("google")}
+        disabled={loading || !hasPlayServices}
+      />
+    </View>
+  );
+}
+```
+
+## Advanced Features
+
+### Global Auth State Listener
+
+Subscribe to authentication changes outside of React components:
+
+```ts
+import { AuthService } from "react-native-nitro-auth";
+
+const unsubscribe = AuthService.onAuthStateChanged((user) => {
+  if (user) {
+    console.log("Logged in:", user.email);
+  } else {
+    console.log("Logged out");
+  }
+});
+
+// Later...
+unsubscribe();
+```
+
+### Standardized Error Codes
+
+Handle failures reliably with predictable error strings:
+
+```ts
+try {
+  await login("google");
+} catch (e) {
+  if (e.message === "cancelled") {
+    // User closed the popup/picker
+  } else if (e.message === "network_error") {
+    // Connection issues
+  }
+}
+```
+
+| Code                   | Description                                    |
+| ---------------------- | ---------------------------------------------- |
+| `cancelled`            | The user cancelled the sign-in flow            |
+| `network_error`        | A network error occurred                       |
+| `configuration_error`  | Missing client IDs or invalid setup            |
+| `unsupported_provider` | The provider is not supported on this platform |
+
+### Automatic Token Refresh
+
+The `getAccessToken()` method automatically checks if the current token is expired (or about to expire) and triggers a silent refresh if possible:
+
+```ts
+const { getAccessToken } = useAuth();
+
+// This will silently refresh if needed!
+const token = await getAccessToken();
+```
+
+### Incremental Authorization
+
+Add more scopes after initial login — no need to re-authenticate:
+
+```tsx
+const { requestScopes, revokeScopes, scopes } = useAuth();
+
+// Request additional scope
+await requestScopes(["https://www.googleapis.com/auth/calendar.readonly"]);
+
+// Check granted scopes
+console.log("Granted:", scopes);
+```
+
+### Manual Token Refresh
+
+While `getAccessToken()` handles auto-refresh, you can manually trigger a refresh to get fresh `idToken` or `expirationTime`:
+
+```ts
+const tokens = await refreshToken();
+console.log("New Expiry:", tokens.expirationTime);
+```
+
+## API Reference
+
+### useAuth Hook
+
+| Property          | Type                              | Description                               |
+| ----------------- | --------------------------------- | ----------------------------------------- |
+| `user`            | `AuthUser \| undefined`           | Current authenticated user                |
+| `scopes`          | `string[]`                        | Currently granted OAuth scopes            |
+| `loading`         | `boolean`                         | True during auth operations               |
+| `error`           | `Error \| undefined`              | Last error that occurred                  |
+| `hasPlayServices` | `boolean`                         | (Android) True if Play Services available |
+| `login`           | `(provider, options?) => Promise` | Start login flow                          |
+| `logout`          | `() => void`                      | Clear session (synchronous)               |
+| `requestScopes`   | `(scopes) => Promise`             | Request additional OAuth scopes           |
+| `getAccessToken`  | `() => Promise<string?>`          | Get current access token (auto-refreshes) |
+| `refreshToken`    | `() => Promise<AuthTokens>`       | Explicitly refresh and return new tokens  |
+
+### SocialButton Props
+
+| Prop        | Type                                           | Default     | Description                      |
+| ----------- | ---------------------------------------------- | ----------- | -------------------------------- |
+| `provider`  | `"google" \| "apple"`                          | required    | Authentication provider          |
+| `variant`   | `"primary" \| "outline" \| "white" \| "black"` | `"primary"` | Button style variant             |
+| `onSuccess` | `(user: AuthUser) => void`                     | —           | Called with user data on success |
+| `onError`   | `(error: Error) => void`                       | —           | Called on failure                |
+
+## Platform Support
+
+| Feature                   | iOS | Android | Web |
+| ------------------------- | --- | ------- | --- |
+| Google Sign-In            | ✅  | ✅      | ✅  |
+| Apple Sign-In             | ✅  | ❌      | ✅  |
+| Custom OAuth Scopes       | ✅  | ✅      | ✅  |
+| Incremental Authorization | ✅  | ✅      | ✅  |
+| Token Refresh             | ✅  | ✅      | ✅  |
+| Session Persistence       | ✅  | ✅      | ✅  |
+| 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:
+
+- **Zero-bridge overhead**: Calls are made directly from JS to C++.
+- **Type safety**: TypeScript types are automatically kept in sync with native C++ and Swift/Kotlin code.
+- **Synchronous access**: Properties like `currentUser` are accessible synchronously without async overhead.
+
+## License
+
+MIT

package/android/CMakeLists.txt

@@ -0,0 +1,37 @@
+cmake_minimum_required(VERSION 3.18.0)
+
+project(NitroAuth)
+
+set(CMAKE_VERBOSE_MAKEFILE ON)
+set(CMAKE_CXX_STANDARD 20)
+
+# 1. Define source files (Manual implementation)
+file(GLOB SOURCES
+  "../cpp/*.cpp"
+  "./src/main/cpp/*.cpp"
+)
+
+# 2. Create the library target
+add_library(
+  NitroAuth
+  SHARED
+  ${SOURCES}
+)
+
+# 3. Include directories for manual sources
+target_include_directories(
+  NitroAuth
+  PRIVATE
+  "../cpp"
+  "./src/main/cpp"
+)
+
+# 4. Include Nitrogen Autolinking (adds generated sources, finding packages, linking libs)
+include("../nitrogen/generated/android/NitroAuth+autolinking.cmake")
+
+# 5. Link standard Android libraries
+target_link_libraries(
+  NitroAuth
+  android
+  log
+)

package/android/build.gradle

@@ -0,0 +1,99 @@
+buildscript {
+  repositories {
+    google()
+    mavenCentral()
+  }
+
+  dependencies {
+    classpath "com.android.tools.build:gradle:8.10.1"
+  }
+}
+
+def reactNativeArchitectures() {
+  def value = rootProject.getProperties().get("reactNativeArchitectures")
+  return value ? value.split(",") : ["armeabi-v7a", "x86", "x86_64", "arm64-v8a"]
+}
+
+def isNewArchitectureEnabled() {
+  return rootProject.hasProperty("newArchEnabled") && rootProject.getProperty("newArchEnabled") == "true"
+}
+
+apply plugin: "com.android.library"
+apply plugin: "org.jetbrains.kotlin.android"
+
+apply from: "../nitrogen/generated/android/NitroAuth+autolinking.gradle"
+
+if (isNewArchitectureEnabled()) {
+  apply plugin: "com.facebook.react"
+}
+
+def getExtOrDefault(name) {
+  return rootProject.ext.has(name) ? rootProject.ext.get(name) : project.properties["NitroAuth_" + name]
+}
+
+def getExtOrIntegerDefault(name) {
+  return rootProject.ext.has(name) ? rootProject.ext.get(name) : (project.properties["NitroAuth_" + name]).toInteger()
+}
+
+android {
+  namespace "com.auth"
+
+  ndkVersion getExtOrDefault("ndkVersion")
+  compileSdkVersion getExtOrIntegerDefault("compileSdkVersion")
+
+  defaultConfig {
+    minSdkVersion getExtOrIntegerDefault("minSdkVersion")
+    targetSdkVersion getExtOrIntegerDefault("targetSdkVersion")
+    buildConfigField "boolean", "IS_NEW_ARCHITECTURE_ENABLED", isNewArchitectureEnabled().toString()
+
+    externalNativeBuild {
+      cmake {
+        cppFlags "-frtti -fexceptions -Wall -Wextra -fstack-protector-all"
+        arguments "-DANDROID_STL=c++_shared", "-DANDROID_SUPPORT_FLEXIBLE_PAGE_SIZES=ON"
+        abiFilters (*reactNativeArchitectures())
+      }
+    }
+  }
+
+  externalNativeBuild {
+    cmake {
+      path "CMakeLists.txt"
+    }
+  }
+
+  buildFeatures {
+    buildConfig true
+    prefab true
+  }
+
+  compileOptions {
+    sourceCompatibility JavaVersion.VERSION_1_8
+    targetCompatibility JavaVersion.VERSION_1_8
+  }
+  
+  sourceSets {
+    main {
+      java.srcDirs += ["src/main/java"]
+      if (isNewArchitectureEnabled()) {
+        java.srcDirs += ["${project.buildDir}/generated/source/codegen/java"]
+      }
+    }
+  }
+}
+
+repositories {
+  mavenCentral()
+  google()
+}
+
+dependencies {
+  implementation "com.facebook.react:react-native:+"
+  implementation "org.jetbrains.kotlin:kotlin-stdlib:1.9.0"
+  implementation project(":react-native-nitro-modules")
+  
+  // Google Sign-In SDK (full scope support)
+  implementation "com.google.android.gms:play-services-auth:21.3.0"
+  
+  // Activity result APIs
+  implementation "androidx.activity:activity-ktx:1.9.3"
+}

package/android/gradle.properties

@@ -0,0 +1,4 @@
+NitroAuth_ndkVersion=27.1.12297006
+NitroAuth_compileSdkVersion=36
+NitroAuth_targetSdkVersion=36
+NitroAuth_minSdkVersion=24

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
+    <uses-permission android:name="android.permission.INTERNET" />
+    
+    <application>
+        <activity
+            android:name="com.auth.GoogleSignInActivity"
+            android:theme="@android:style/Theme.Translucent.NoTitleBar"
+            android:exported="false" />
+    </application>
+</manifest>

package/android/src/main/cpp/JniOnLoad.cpp

@@ -0,0 +1,7 @@
+#include <jni.h>
+#include <fbjni/fbjni.h>
+#include "NitroAuthOnLoad.hpp"
+
+extern "C" JNIEXPORT jint JNICALL JNI_OnLoad(JavaVM* vm, void* reserved) {
+  return margelo::nitro::NitroAuth::initialize(vm);
+}