diff --git a/.changeset/brave-clouds-swim.md b/.changeset/brave-clouds-swim.md new file mode 100644 index 00000000000..cc611bc48c1 --- /dev/null +++ b/.changeset/brave-clouds-swim.md @@ -0,0 +1,5 @@ +--- +'@clerk/expo': minor +--- + +Add native Google Sign-In support for iOS and Android using built-in native modules. diff --git a/packages/expo/android/build.gradle b/packages/expo/android/build.gradle new file mode 100644 index 00000000000..ee1fab8fa00 --- /dev/null +++ b/packages/expo/android/build.gradle @@ -0,0 +1,64 @@ +apply plugin: 'com.android.library' +apply plugin: 'kotlin-android' + +group = 'com.clerk.expo' +version = '1.0.0' + +// Dependency versions - centralized for easier updates +// See: https://docs.gradle.org/current/userguide/version_catalogs.html for app-level version catalogs +ext { + credentialsVersion = "1.3.0" + googleIdVersion = "1.1.1" + kotlinxCoroutinesVersion = "1.7.3" +} + +def safeExtGet(prop, fallback) { + rootProject.ext.has(prop) ? rootProject.ext.get(prop) : fallback +} + +android { + namespace "expo.modules.clerk.googlesignin" + + compileSdk safeExtGet("compileSdkVersion", 36) + + defaultConfig { + minSdk safeExtGet("minSdkVersion", 24) + targetSdk safeExtGet("targetSdkVersion", 36) + versionCode 1 + versionName "1.0.0" + } + + buildTypes { + release { + minifyEnabled false + } + } + + compileOptions { + sourceCompatibility JavaVersion.VERSION_17 + targetCompatibility JavaVersion.VERSION_17 + } + + kotlinOptions { + jvmTarget = "17" + } + + sourceSets { + main { + java.srcDirs = ['src/main/java'] + } + } +} + +dependencies { + // Expo modules core + implementation project(':expo-modules-core') + + // Credential Manager for Google Sign-In with nonce support + implementation "androidx.credentials:credentials:$credentialsVersion" + implementation "androidx.credentials:credentials-play-services-auth:$credentialsVersion" + implementation "com.google.android.libraries.identity.googleid:googleid:$googleIdVersion" + + // Coroutines for async operations + implementation "org.jetbrains.kotlinx:kotlinx-coroutines-android:$kotlinxCoroutinesVersion" +} diff --git a/packages/expo/android/src/main/AndroidManifest.xml b/packages/expo/android/src/main/AndroidManifest.xml new file mode 100644 index 00000000000..a2f47b6057d --- /dev/null +++ b/packages/expo/android/src/main/AndroidManifest.xml @@ -0,0 +1,2 @@ + + diff --git a/packages/expo/android/src/main/java/expo/modules/clerk/googlesignin/ClerkGoogleSignInModule.kt b/packages/expo/android/src/main/java/expo/modules/clerk/googlesignin/ClerkGoogleSignInModule.kt new file mode 100644 index 00000000000..3234fea2214 --- /dev/null +++ b/packages/expo/android/src/main/java/expo/modules/clerk/googlesignin/ClerkGoogleSignInModule.kt @@ -0,0 +1,264 @@ +package expo.modules.clerk.googlesignin + +import android.content.Context +import androidx.credentials.ClearCredentialStateRequest +import androidx.credentials.CredentialManager +import androidx.credentials.CustomCredential +import androidx.credentials.GetCredentialRequest +import androidx.credentials.GetCredentialResponse +import androidx.credentials.exceptions.GetCredentialCancellationException +import androidx.credentials.exceptions.GetCredentialException +import androidx.credentials.exceptions.NoCredentialException +import com.google.android.libraries.identity.googleid.GetGoogleIdOption +import com.google.android.libraries.identity.googleid.GetSignInWithGoogleOption +import com.google.android.libraries.identity.googleid.GoogleIdTokenCredential +import com.google.android.libraries.identity.googleid.GoogleIdTokenParsingException +import expo.modules.kotlin.Promise +import expo.modules.kotlin.exception.CodedException +import expo.modules.kotlin.modules.Module +import expo.modules.kotlin.modules.ModuleDefinition +import expo.modules.kotlin.records.Field +import expo.modules.kotlin.records.Record +import kotlinx.coroutines.CoroutineScope +import kotlinx.coroutines.Dispatchers +import kotlinx.coroutines.launch + +// Configuration parameters +class ConfigureParams : Record { + @Field + val webClientId: String = "" + + @Field + val hostedDomain: String? = null + + @Field + val autoSelectEnabled: Boolean? = null +} + +// Sign-in parameters +class SignInParams : Record { + @Field + val nonce: String? = null + + @Field + val filterByAuthorizedAccounts: Boolean? = null +} + +// Create account parameters +class CreateAccountParams : Record { + @Field + val nonce: String? = null +} + +// Explicit sign-in parameters +class ExplicitSignInParams : Record { + @Field + val nonce: String? = null +} + +// Custom exceptions +class GoogleSignInCancelledException : CodedException("SIGN_IN_CANCELLED", "User cancelled the sign-in flow", null) +class GoogleSignInNoCredentialException : CodedException("NO_SAVED_CREDENTIAL_FOUND", "No saved credential found", null) +class GoogleSignInException(message: String) : CodedException("GOOGLE_SIGN_IN_ERROR", message, null) +class GoogleSignInNotConfiguredException : CodedException("NOT_CONFIGURED", "Google Sign-In is not configured. Call configure() first.", null) +class GoogleSignInActivityUnavailableException : CodedException("E_ACTIVITY_UNAVAILABLE", "Activity is not available", null) + +class ClerkGoogleSignInModule : Module() { + private var webClientId: String? = null + private var hostedDomain: String? = null + private var autoSelectEnabled: Boolean = false + private val mainScope = CoroutineScope(Dispatchers.Main) + + private val context: Context + get() = requireNotNull(appContext.reactContext) + + private val credentialManager: CredentialManager + get() = CredentialManager.create(context) + + override fun definition() = ModuleDefinition { + Name("ClerkGoogleSignIn") + + // Configure the module + Function("configure") { params: ConfigureParams -> + webClientId = params.webClientId + hostedDomain = params.hostedDomain + autoSelectEnabled = params.autoSelectEnabled ?: false + } + + // Sign in - attempts automatic sign-in with saved credentials + AsyncFunction("signIn") { params: SignInParams?, promise: Promise -> + val clientId = webClientId ?: run { + promise.reject(GoogleSignInNotConfiguredException()) + return@AsyncFunction + } + + val activity = appContext.currentActivity ?: run { + promise.reject(GoogleSignInActivityUnavailableException()) + return@AsyncFunction + } + + mainScope.launch { + try { + val googleIdOption = GetGoogleIdOption.Builder() + .setFilterByAuthorizedAccounts(params?.filterByAuthorizedAccounts ?: true) + .setServerClientId(clientId) + .setAutoSelectEnabled(autoSelectEnabled) + .apply { + params?.nonce?.let { setNonce(it) } + } + .build() + + val request = GetCredentialRequest.Builder() + .addCredentialOption(googleIdOption) + .build() + + val result = credentialManager.getCredential( + request = request, + context = activity + ) + + handleSignInResult(result, promise) + } catch (e: GetCredentialCancellationException) { + promise.reject(GoogleSignInCancelledException()) + } catch (e: NoCredentialException) { + promise.reject(GoogleSignInNoCredentialException()) + } catch (e: GetCredentialException) { + promise.reject(GoogleSignInException(e.message ?: "Unknown error")) + } catch (e: Exception) { + promise.reject(GoogleSignInException(e.message ?: "Unknown error")) + } + } + } + + // Create account - shows account creation UI + AsyncFunction("createAccount") { params: CreateAccountParams?, promise: Promise -> + val clientId = webClientId ?: run { + promise.reject(GoogleSignInNotConfiguredException()) + return@AsyncFunction + } + + val activity = appContext.currentActivity ?: run { + promise.reject(GoogleSignInActivityUnavailableException()) + return@AsyncFunction + } + + mainScope.launch { + try { + val googleIdOption = GetGoogleIdOption.Builder() + .setFilterByAuthorizedAccounts(false) // Show all accounts for creation + .setServerClientId(clientId) + .apply { + params?.nonce?.let { setNonce(it) } + } + .build() + + val request = GetCredentialRequest.Builder() + .addCredentialOption(googleIdOption) + .build() + + val result = credentialManager.getCredential( + request = request, + context = activity + ) + + handleSignInResult(result, promise) + } catch (e: GetCredentialCancellationException) { + promise.reject(GoogleSignInCancelledException()) + } catch (e: NoCredentialException) { + promise.reject(GoogleSignInNoCredentialException()) + } catch (e: GetCredentialException) { + promise.reject(GoogleSignInException(e.message ?: "Unknown error")) + } catch (e: Exception) { + promise.reject(GoogleSignInException(e.message ?: "Unknown error")) + } + } + } + + // Explicit sign-in - uses Sign In With Google button flow + AsyncFunction("presentExplicitSignIn") { params: ExplicitSignInParams?, promise: Promise -> + val clientId = webClientId ?: run { + promise.reject(GoogleSignInNotConfiguredException()) + return@AsyncFunction + } + + val activity = appContext.currentActivity ?: run { + promise.reject(GoogleSignInActivityUnavailableException()) + return@AsyncFunction + } + + mainScope.launch { + try { + val signInWithGoogleOption = GetSignInWithGoogleOption.Builder(clientId) + .apply { + params?.nonce?.let { setNonce(it) } + hostedDomain?.let { setHostedDomainFilter(it) } + } + .build() + + val request = GetCredentialRequest.Builder() + .addCredentialOption(signInWithGoogleOption) + .build() + + val result = credentialManager.getCredential( + request = request, + context = activity + ) + + handleSignInResult(result, promise) + } catch (e: GetCredentialCancellationException) { + promise.reject(GoogleSignInCancelledException()) + } catch (e: GetCredentialException) { + promise.reject(GoogleSignInException(e.message ?: "Unknown error")) + } catch (e: Exception) { + promise.reject(GoogleSignInException(e.message ?: "Unknown error")) + } + } + } + + // Sign out - clears credential state + AsyncFunction("signOut") { promise: Promise -> + mainScope.launch { + try { + credentialManager.clearCredentialState(ClearCredentialStateRequest()) + promise.resolve(null) + } catch (e: Exception) { + promise.reject(GoogleSignInException(e.message ?: "Failed to sign out")) + } + } + } + } + + private fun handleSignInResult(result: GetCredentialResponse, promise: Promise) { + when (val credential = result.credential) { + is CustomCredential -> { + if (credential.type == GoogleIdTokenCredential.TYPE_GOOGLE_ID_TOKEN_CREDENTIAL) { + try { + val googleIdTokenCredential = GoogleIdTokenCredential.createFrom(credential.data) + + promise.resolve(mapOf( + "type" to "success", + "data" to mapOf( + "idToken" to googleIdTokenCredential.idToken, + "user" to mapOf( + "id" to googleIdTokenCredential.id, + "email" to googleIdTokenCredential.id, + "name" to googleIdTokenCredential.displayName, + "givenName" to googleIdTokenCredential.givenName, + "familyName" to googleIdTokenCredential.familyName, + "photo" to googleIdTokenCredential.profilePictureUri?.toString() + ) + ) + )) + } catch (e: GoogleIdTokenParsingException) { + promise.reject(GoogleSignInException("Failed to parse Google ID token: ${e.message}")) + } + } else { + promise.reject(GoogleSignInException("Unexpected credential type: ${credential.type}")) + } + } + else -> { + promise.reject(GoogleSignInException("Unexpected credential type")) + } + } + } +} diff --git a/packages/expo/app.plugin.js b/packages/expo/app.plugin.js new file mode 100644 index 00000000000..974c376b2c1 --- /dev/null +++ b/packages/expo/app.plugin.js @@ -0,0 +1,44 @@ +const { createRunOncePlugin, withInfoPlist } = require('@expo/config-plugins'); + +/** + * Expo config plugin for @clerk/clerk-expo. + * + * This plugin configures the iOS URL scheme required for Google Sign-In. + * The native Android module is automatically linked via expo-module.config.json. + */ +function withClerkGoogleSignIn(config) { + // Get the iOS URL scheme from environment or config.extra + // We capture it here before entering the mod callback + const iosUrlScheme = + process.env.EXPO_PUBLIC_CLERK_GOOGLE_IOS_URL_SCHEME || config.extra?.EXPO_PUBLIC_CLERK_GOOGLE_IOS_URL_SCHEME; + + if (!iosUrlScheme) { + // No URL scheme configured, skip iOS configuration + return config; + } + + // Add iOS URL scheme for Google Sign-In + config = withInfoPlist(config, modConfig => { + if (!Array.isArray(modConfig.modResults.CFBundleURLTypes)) { + modConfig.modResults.CFBundleURLTypes = []; + } + + // Check if the scheme is already added to avoid duplicates + const schemeExists = modConfig.modResults.CFBundleURLTypes.some(urlType => + urlType.CFBundleURLSchemes?.includes(iosUrlScheme), + ); + + if (!schemeExists) { + // Add Google Sign-In URL scheme + modConfig.modResults.CFBundleURLTypes.push({ + CFBundleURLSchemes: [iosUrlScheme], + }); + } + + return modConfig; + }); + + return config; +} + +module.exports = createRunOncePlugin(withClerkGoogleSignIn, '@clerk/clerk-expo', '1.0.0'); diff --git a/packages/expo/expo-module.config.json b/packages/expo/expo-module.config.json new file mode 100644 index 00000000000..e59f14eef13 --- /dev/null +++ b/packages/expo/expo-module.config.json @@ -0,0 +1,9 @@ +{ + "platforms": ["android", "ios"], + "android": { + "modules": ["expo.modules.clerk.googlesignin.ClerkGoogleSignInModule"] + }, + "ios": { + "modules": ["ClerkGoogleSignInModule"] + } +} diff --git a/packages/expo/ios/ClerkGoogleSignIn.podspec b/packages/expo/ios/ClerkGoogleSignIn.podspec new file mode 100644 index 00000000000..be0f3551b2b --- /dev/null +++ b/packages/expo/ios/ClerkGoogleSignIn.podspec @@ -0,0 +1,22 @@ +require 'json' + +package = JSON.parse(File.read(File.join(__dir__, '..', 'package.json'))) + +Pod::Spec.new do |s| + s.name = 'ClerkGoogleSignIn' + s.version = package['version'] + s.summary = 'Native Google Sign-In module for Clerk Expo' + s.description = 'Native Google Sign-In functionality using Google Sign-In SDK with nonce support for Clerk authentication' + s.license = package['license'] + s.author = package['author'] + s.homepage = package['homepage'] + s.platforms = { :ios => '13.4' } + s.swift_version = '5.4' + s.source = { :git => 'https://github.com/clerk/javascript.git' } + s.static_framework = true + + s.dependency 'ExpoModulesCore' + s.dependency 'GoogleSignIn', '~> 9.0' + + s.source_files = '*.swift' +end diff --git a/packages/expo/ios/ClerkGoogleSignInModule.swift b/packages/expo/ios/ClerkGoogleSignInModule.swift new file mode 100644 index 00000000000..c06f85b8031 --- /dev/null +++ b/packages/expo/ios/ClerkGoogleSignInModule.swift @@ -0,0 +1,229 @@ +import ExpoModulesCore +import GoogleSignIn + +public class ClerkGoogleSignInModule: Module { + private var clientId: String? + private var hostedDomain: String? + + public func definition() -> ModuleDefinition { + Name("ClerkGoogleSignIn") + + // Configure the module + Function("configure") { (params: ConfigureParams) in + self.clientId = params.iosClientId ?? params.webClientId + self.hostedDomain = params.hostedDomain + + // Set the configuration globally + // clientID: iOS client ID for OAuth flow + // serverClientID: Web client ID for token audience (what Clerk backend verifies) + if let clientId = self.clientId { + let config = GIDConfiguration( + clientID: clientId, + serverClientID: params.webClientId + ) + GIDSignIn.sharedInstance.configuration = config + } + } + + // Sign in - attempts sign-in with hint if available + AsyncFunction("signIn") { (params: SignInParams?, promise: Promise) in + guard self.clientId != nil else { + promise.reject(NotConfiguredException()) + return + } + + DispatchQueue.main.async { + guard let presentingVC = self.getPresentingViewController() else { + promise.reject(GoogleSignInException(message: "No presenting view controller available")) + return + } + + // Build sign-in hint if filtering by authorized accounts + let hint: String? = params?.filterByAuthorizedAccounts == true + ? GIDSignIn.sharedInstance.currentUser?.profile?.email + : nil + + GIDSignIn.sharedInstance.signIn( + withPresenting: presentingVC, + hint: hint, + additionalScopes: nil, + nonce: params?.nonce + ) { result, error in + self.handleSignInResult(result: result, error: error, promise: promise) + } + } + } + + // Create account - shows account creation UI (same as sign in on iOS) + AsyncFunction("createAccount") { (params: CreateAccountParams?, promise: Promise) in + guard self.clientId != nil else { + promise.reject(NotConfiguredException()) + return + } + + DispatchQueue.main.async { + guard let presentingVC = self.getPresentingViewController() else { + promise.reject(GoogleSignInException(message: "No presenting view controller available")) + return + } + + GIDSignIn.sharedInstance.signIn( + withPresenting: presentingVC, + hint: nil, + additionalScopes: nil, + nonce: params?.nonce + ) { result, error in + self.handleSignInResult(result: result, error: error, promise: promise) + } + } + } + + // Explicit sign-in - uses standard Google Sign-In flow + AsyncFunction("presentExplicitSignIn") { (params: ExplicitSignInParams?, promise: Promise) in + guard self.clientId != nil else { + promise.reject(NotConfiguredException()) + return + } + + DispatchQueue.main.async { + guard let presentingVC = self.getPresentingViewController() else { + promise.reject(GoogleSignInException(message: "No presenting view controller available")) + return + } + + GIDSignIn.sharedInstance.signIn( + withPresenting: presentingVC, + hint: nil, + additionalScopes: nil, + nonce: params?.nonce + ) { result, error in + self.handleSignInResult(result: result, error: error, promise: promise) + } + } + } + + // Sign out - clears credential state + AsyncFunction("signOut") { (promise: Promise) in + GIDSignIn.sharedInstance.signOut() + promise.resolve(nil) + } + } + + private func getPresentingViewController() -> UIViewController? { + guard let scene = UIApplication.shared.connectedScenes.first as? UIWindowScene, + let window = scene.windows.first, + let rootVC = window.rootViewController else { + return nil + } + + var topVC = rootVC + while let presentedVC = topVC.presentedViewController { + topVC = presentedVC + } + return topVC + } + + private func handleSignInResult(result: GIDSignInResult?, error: Error?, promise: Promise) { + if let error = error { + let nsError = error as NSError + + // Check for user cancellation + if nsError.domain == kGIDSignInErrorDomain && nsError.code == GIDSignInError.canceled.rawValue { + promise.reject(SignInCancelledException()) + return + } + + promise.reject(GoogleSignInException(message: error.localizedDescription)) + return + } + + guard let result = result, + let idToken = result.user.idToken?.tokenString else { + promise.reject(GoogleSignInException(message: "No ID token received")) + return + } + + let user = result.user + let profile = user.profile + + let response: [String: Any] = [ + "type": "success", + "data": [ + "idToken": idToken, + "user": [ + "id": user.userID ?? "", + "email": profile?.email ?? "", + "name": profile?.name ?? "", + "givenName": profile?.givenName ?? "", + "familyName": profile?.familyName ?? "", + "photo": profile?.imageURL(withDimension: 200)?.absoluteString ?? NSNull() + ] as [String: Any] + ] as [String: Any] + ] + + promise.resolve(response) + } +} + +// MARK: - Records + +struct ConfigureParams: Record { + @Field + var webClientId: String = "" + + @Field + var iosClientId: String? + + @Field + var hostedDomain: String? + + @Field + var autoSelectEnabled: Bool? +} + +struct SignInParams: Record { + @Field + var nonce: String? + + @Field + var filterByAuthorizedAccounts: Bool? +} + +struct CreateAccountParams: Record { + @Field + var nonce: String? +} + +struct ExplicitSignInParams: Record { + @Field + var nonce: String? +} + +// MARK: - Exceptions + +class SignInCancelledException: Exception { + override var code: String { "SIGN_IN_CANCELLED" } + override var reason: String { "User cancelled the sign-in flow" } +} + +class NoSavedCredentialException: Exception { + override var code: String { "NO_SAVED_CREDENTIAL_FOUND" } + override var reason: String { "No saved credential found" } +} + +class NotConfiguredException: Exception { + override var code: String { "NOT_CONFIGURED" } + override var reason: String { "Google Sign-In is not configured. Call configure() first." } +} + +class GoogleSignInException: Exception { + private let errorMessage: String + + init(message: String) { + self.errorMessage = message + super.init() + } + + override var code: String { "GOOGLE_SIGN_IN_ERROR" } + override var reason: String { errorMessage } +} diff --git a/packages/expo/package.json b/packages/expo/package.json index d380e29ce6a..8234975313e 100644 --- a/packages/expo/package.json +++ b/packages/expo/package.json @@ -56,16 +56,28 @@ "types": "./dist/experimental.d.ts", "default": "./dist/experimental.js" }, - "./legacy": { - "types": "./dist/legacy.d.ts", - "default": "./dist/legacy.js" - } + "./google-one-tap": { + "types": "./dist/google-one-tap/index.d.ts", + "default": "./dist/google-one-tap/index.js" + }, + "./app.plugin.js": "./app.plugin.js", + "./package.json": "./package.json" }, "main": "./dist/index.js", "source": "./src/index.ts", "types": "./dist/index.d.ts", "files": [ - "dist" + "dist", + "android", + "ios", + "expo-module.config.json", + "app.plugin.js", + "web", + "local-credentials", + "passkeys", + "secure-store", + "resource-cache", + "token-cache" ], "scripts": { "build": "tsup", @@ -93,19 +105,22 @@ "@types/base-64": "^1.0.2", "expo-apple-authentication": "^7.2.4", "expo-auth-session": "^5.4.0", + "expo-constants": "^18.0.0", "expo-crypto": "^15.0.7", "expo-local-authentication": "^13.8.0", + "expo-modules-core": "^3.0.0", "expo-secure-store": "^12.8.1", "expo-web-browser": "^12.8.2", "react-native": "^0.81.4" }, "peerDependencies": { "@clerk/expo-passkeys": ">=0.0.6", - "expo": ">=53 <55", "expo-apple-authentication": ">=7.0.0", "expo-auth-session": ">=5", + "expo-constants": ">=12", "expo-crypto": ">=12", "expo-local-authentication": ">=13.5.0", + "expo-modules-core": ">=3.0.0", "expo-secure-store": ">=12.4.0", "expo-web-browser": ">=12.5.0", "react": "catalog:peer-react", @@ -119,6 +134,9 @@ "expo-apple-authentication": { "optional": true }, + "expo-constants": { + "optional": true + }, "expo-crypto": { "optional": true }, diff --git a/packages/expo/src/google-one-tap/ClerkGoogleOneTapSignIn.ts b/packages/expo/src/google-one-tap/ClerkGoogleOneTapSignIn.ts new file mode 100644 index 00000000000..00004316b05 --- /dev/null +++ b/packages/expo/src/google-one-tap/ClerkGoogleOneTapSignIn.ts @@ -0,0 +1,205 @@ +import { requireNativeModule } from 'expo-modules-core'; + +import type { + CancelledResponse, + ConfigureParams, + CreateAccountParams, + ExplicitSignInParams, + NoSavedCredentialFound, + OneTapResponse, + OneTapSuccessResponse, + SignInParams, +} from './types'; + +// Type for the native module methods +interface ClerkGoogleSignInNativeModule { + configure(params: ConfigureParams): void; + signIn(params: SignInParams): Promise; + createAccount(params: CreateAccountParams): Promise; + presentExplicitSignIn(params: ExplicitSignInParams): Promise; + signOut(): Promise; +} + +// Lazy-load the native module to avoid crashes when not available +let _nativeModule: ClerkGoogleSignInNativeModule | null = null; + +function getNativeModule(): ClerkGoogleSignInNativeModule { + if (!_nativeModule) { + _nativeModule = requireNativeModule('ClerkGoogleSignIn'); + } + return _nativeModule; +} + +/** + * Check if a response indicates the user cancelled the sign-in flow. + */ +export function isCancelledResponse(response: OneTapResponse): response is CancelledResponse { + return response.type === 'cancelled'; +} + +/** + * Check if a response indicates no saved credential was found. + */ +export function isNoSavedCredentialFoundResponse(response: OneTapResponse): response is NoSavedCredentialFound { + return response.type === 'noSavedCredentialFound'; +} + +/** + * Check if a response is a successful sign-in. + */ +export function isSuccessResponse(response: OneTapResponse): response is OneTapSuccessResponse { + return response.type === 'success'; +} + +/** + * Check if an error has a code property (Google Sign-In error). + */ +export function isErrorWithCode(error: unknown): error is { code: string; message: string } { + return ( + error !== null && + typeof error === 'object' && + 'code' in error && + typeof (error as { code: unknown }).code === 'string' + ); +} + +/** + * Clerk's Google One Tap Sign-In module for Android. + * + * This module provides native Google Sign-In functionality using Google's + * Credential Manager API with full nonce support for replay attack protection. + * + * @example + * ```typescript + * import { ClerkGoogleOneTapSignIn } from '@clerk/clerk-expo'; + * + * // Configure once at app startup + * ClerkGoogleOneTapSignIn.configure({ + * webClientId: 'YOUR_WEB_CLIENT_ID', + * }); + * + * // Sign in with nonce + * const nonce = generateNonce(); + * const response = await ClerkGoogleOneTapSignIn.signIn({ nonce }); + * + * if (response.type === 'success') { + * const { idToken } = response.data; + * // Use idToken with Clerk + * } + * ``` + * + * @platform Android + */ +export const ClerkGoogleOneTapSignIn = { + /** + * Configure Google Sign-In. Must be called before any sign-in methods. + * + * @param params - Configuration parameters + * @param params.webClientId - The web client ID from Google Cloud Console (required) + * @param params.hostedDomain - Optional domain restriction + * @param params.autoSelectEnabled - Auto-select for single credential (default: false) + */ + configure(params: ConfigureParams): void { + getNativeModule().configure(params); + }, + + /** + * Attempt to sign in with saved credentials (One Tap). + * + * This method will show the One Tap UI if there are saved credentials, + * or return a "noSavedCredentialFound" response if there are none. + * + * @param params - Sign-in parameters + * @param params.nonce - Cryptographic nonce for replay protection + * @param params.filterByAuthorizedAccounts - Only show previously authorized accounts (default: true) + * + * @returns Promise resolving to OneTapResponse + */ + async signIn(params?: SignInParams): Promise { + try { + return await getNativeModule().signIn(params ?? {}); + } catch (error) { + if (isErrorWithCode(error)) { + if (error.code === 'SIGN_IN_CANCELLED') { + return { type: 'cancelled', data: null }; + } + if (error.code === 'NO_SAVED_CREDENTIAL_FOUND') { + return { type: 'noSavedCredentialFound', data: null }; + } + } + throw error; + } + }, + + /** + * Create a new account (shows all Google accounts). + * + * This method shows the account picker with all available Google accounts, + * not just previously authorized ones. + * + * @param params - Create account parameters + * @param params.nonce - Cryptographic nonce for replay protection + * + * @returns Promise resolving to OneTapResponse + */ + async createAccount(params?: CreateAccountParams): Promise { + try { + return await getNativeModule().createAccount(params ?? {}); + } catch (error) { + if (isErrorWithCode(error)) { + if (error.code === 'SIGN_IN_CANCELLED') { + return { type: 'cancelled', data: null }; + } + if (error.code === 'NO_SAVED_CREDENTIAL_FOUND') { + return { type: 'noSavedCredentialFound', data: null }; + } + } + throw error; + } + }, + + /** + * Present explicit sign-in UI (Google Sign-In button flow). + * + * This shows the full Google Sign-In UI, similar to clicking a + * "Sign in with Google" button. + * + * @param params - Explicit sign-in parameters + * @param params.nonce - Cryptographic nonce for replay protection + * + * @returns Promise resolving to OneTapResponse + */ + async presentExplicitSignIn(params?: ExplicitSignInParams): Promise { + try { + return await getNativeModule().presentExplicitSignIn(params ?? {}); + } catch (error) { + if (isErrorWithCode(error)) { + if (error.code === 'SIGN_IN_CANCELLED') { + return { type: 'cancelled', data: null }; + } + } + throw error; + } + }, + + /** + * Sign out and clear credential state. + * + * This disables automatic sign-in until the user signs in again. + */ + async signOut(): Promise { + await getNativeModule().signOut(); + }, +}; + +export type { + ConfigureParams, + SignInParams, + CreateAccountParams, + ExplicitSignInParams, + OneTapResponse, + OneTapSuccessResponse, + CancelledResponse, + NoSavedCredentialFound, + GoogleUser, +} from './types'; diff --git a/packages/expo/src/google-one-tap/index.ts b/packages/expo/src/google-one-tap/index.ts new file mode 100644 index 00000000000..1877117ef61 --- /dev/null +++ b/packages/expo/src/google-one-tap/index.ts @@ -0,0 +1,21 @@ +export { + ClerkGoogleOneTapSignIn, + isCancelledResponse, + isNoSavedCredentialFoundResponse, + isSuccessResponse, + isErrorWithCode, +} from './ClerkGoogleOneTapSignIn'; + +export type { + ConfigureParams, + SignInParams, + CreateAccountParams, + ExplicitSignInParams, + OneTapResponse, + OneTapSuccessResponse, + CancelledResponse, + NoSavedCredentialFound, + GoogleUser, + GoogleSignInError, + GoogleSignInErrorCode, +} from './types'; diff --git a/packages/expo/src/google-one-tap/types.ts b/packages/expo/src/google-one-tap/types.ts new file mode 100644 index 00000000000..98cd34c4d1a --- /dev/null +++ b/packages/expo/src/google-one-tap/types.ts @@ -0,0 +1,162 @@ +/** + * Configuration parameters for Google One Tap Sign-In. + */ +export type ConfigureParams = { + /** + * The web client ID from Google Cloud Console. + * This is required for Google Sign-In to work. + * On iOS, this is used as the serverClientID for token audience. + */ + webClientId: string; + + /** + * The iOS client ID from Google Cloud Console. + * This is only used on iOS for the OAuth flow. + * If not provided, webClientId will be used. + * @platform iOS + */ + iosClientId?: string; + + /** + * Optional hosted domain to restrict sign-in to a specific domain. + */ + hostedDomain?: string; + + /** + * Whether to enable auto-select for returning users. + * When true, if only one credential is available, it will be automatically selected. + * @default false + */ + autoSelectEnabled?: boolean; +}; + +/** + * Parameters for the signIn method. + */ +export type SignInParams = { + /** + * A cryptographically random string used to mitigate replay attacks. + * The nonce will be included in the ID token. + */ + nonce?: string; + + /** + * Whether to filter credentials to only show accounts that have been + * previously authorized for this app. + * @default true + */ + filterByAuthorizedAccounts?: boolean; +}; + +/** + * Parameters for the createAccount method. + */ +export type CreateAccountParams = { + /** + * A cryptographically random string used to mitigate replay attacks. + * The nonce will be included in the ID token. + */ + nonce?: string; +}; + +/** + * Parameters for the presentExplicitSignIn method. + */ +export type ExplicitSignInParams = { + /** + * A cryptographically random string used to mitigate replay attacks. + * The nonce will be included in the ID token. + */ + nonce?: string; +}; + +/** + * User information returned from Google Sign-In. + */ +export type GoogleUser = { + /** + * The user's unique Google identifier (OIDC "sub" claim). + * This is distinct from the user's email address. + */ + id: string; + + /** + * The user's email address. + */ + email: string; + + /** + * The user's full display name. + */ + name: string | null; + + /** + * The user's given (first) name. + */ + givenName: string | null; + + /** + * The user's family (last) name. + */ + familyName: string | null; + + /** + * URL to the user's profile picture. + */ + photo: string | null; +}; + +/** + * Successful sign-in response. + */ +export type OneTapSuccessResponse = { + type: 'success'; + data: { + /** + * The Google ID token containing user information and nonce. + */ + idToken: string; + + /** + * The user's information. + */ + user: GoogleUser; + }; +}; + +/** + * Response when the user cancels the sign-in flow. + */ +export type CancelledResponse = { + type: 'cancelled'; + data: null; +}; + +/** + * Response when no saved credential is found. + */ +export type NoSavedCredentialFound = { + type: 'noSavedCredentialFound'; + data: null; +}; + +/** + * Union type for all possible One Tap responses. + */ +export type OneTapResponse = OneTapSuccessResponse | CancelledResponse | NoSavedCredentialFound; + +/** + * Error codes that can be thrown by the Google Sign-In module. + */ +export type GoogleSignInErrorCode = + | 'SIGN_IN_CANCELLED' + | 'NO_SAVED_CREDENTIAL_FOUND' + | 'NOT_CONFIGURED' + | 'GOOGLE_SIGN_IN_ERROR'; + +/** + * Error thrown by the Google Sign-In module. + */ +export interface GoogleSignInError extends Error { + code: GoogleSignInErrorCode; +} diff --git a/packages/expo/src/hooks/__tests__/useSignInWithGoogle.test.ts b/packages/expo/src/hooks/__tests__/useSignInWithGoogle.test.ts new file mode 100644 index 00000000000..8b46bdf2165 --- /dev/null +++ b/packages/expo/src/hooks/__tests__/useSignInWithGoogle.test.ts @@ -0,0 +1,270 @@ +import { renderHook } from '@testing-library/react'; +import { afterEach, beforeEach, describe, expect, test, vi } from 'vitest'; + +import { useSignInWithGoogle } from '../useSignInWithGoogle.android'; + +const mocks = vi.hoisted(() => { + return { + useSignIn: vi.fn(), + useSignUp: vi.fn(), + ClerkGoogleOneTapSignIn: { + configure: vi.fn(), + presentExplicitSignIn: vi.fn(), + }, + isSuccessResponse: vi.fn(), + }; +}); + +vi.mock('@clerk/react/legacy', () => { + return { + useSignIn: mocks.useSignIn, + useSignUp: mocks.useSignUp, + }; +}); + +vi.mock('../../google-one-tap', () => { + return { + ClerkGoogleOneTapSignIn: mocks.ClerkGoogleOneTapSignIn, + isSuccessResponse: mocks.isSuccessResponse, + }; +}); + +vi.mock('react-native', () => { + return { + Platform: { + OS: 'android', + }, + }; +}); + +vi.mock('expo-modules-core', () => { + return { + EventEmitter: vi.fn(), + requireNativeModule: vi.fn(), + }; +}); + +vi.mock('expo-constants', () => { + return { + default: { + expoConfig: { + extra: { + EXPO_PUBLIC_CLERK_GOOGLE_WEB_CLIENT_ID: 'mock-web-client-id.apps.googleusercontent.com', + }, + }, + }, + }; +}); + +vi.mock('expo-crypto', () => { + return { + randomUUID: vi.fn(() => 'mock-uuid-nonce'), + digestStringAsync: vi.fn(() => Promise.resolve('mock-hashed-nonce')), + CryptoDigestAlgorithm: { + SHA256: 'SHA256', + }, + }; +}); + +describe('useSignInWithGoogle', () => { + const mockSignIn = { + create: vi.fn(), + createdSessionId: 'test-session-id', + firstFactorVerification: { + status: 'verified', + }, + }; + + const mockSignUp = { + create: vi.fn(), + createdSessionId: null, + }; + + const mockSetActive = vi.fn(); + + beforeEach(() => { + vi.clearAllMocks(); + + mocks.useSignIn.mockReturnValue({ + signIn: mockSignIn, + setActive: mockSetActive, + isLoaded: true, + }); + + mocks.useSignUp.mockReturnValue({ + signUp: mockSignUp, + isLoaded: true, + }); + }); + + afterEach(() => { + vi.restoreAllMocks(); + }); + + describe('startGoogleAuthenticationFlow', () => { + test('should return the hook with startGoogleAuthenticationFlow function', () => { + const { result } = renderHook(() => useSignInWithGoogle()); + + expect(result.current).toHaveProperty('startGoogleAuthenticationFlow'); + expect(typeof result.current.startGoogleAuthenticationFlow).toBe('function'); + }); + + test('should successfully sign in existing user', async () => { + const mockIdToken = 'mock-id-token'; + mocks.ClerkGoogleOneTapSignIn.presentExplicitSignIn.mockResolvedValue({ + type: 'success', + data: { idToken: mockIdToken }, + }); + mocks.isSuccessResponse.mockReturnValue(true); + + mockSignIn.create.mockResolvedValue(undefined); + mockSignIn.firstFactorVerification.status = 'verified'; + mockSignIn.createdSessionId = 'test-session-id'; + + const { result } = renderHook(() => useSignInWithGoogle()); + + const response = await result.current.startGoogleAuthenticationFlow(); + + expect(mocks.ClerkGoogleOneTapSignIn.configure).toHaveBeenCalledWith({ + webClientId: 'mock-web-client-id.apps.googleusercontent.com', + }); + expect(mocks.ClerkGoogleOneTapSignIn.presentExplicitSignIn).toHaveBeenCalledWith({ + nonce: 'mock-uuid-nonce', + }); + expect(mockSignIn.create).toHaveBeenCalledWith({ + strategy: 'google_one_tap', + token: mockIdToken, + }); + expect(response.createdSessionId).toBe('test-session-id'); + expect(response.setActive).toBe(mockSetActive); + }); + + test('should handle transfer flow for new user', async () => { + const mockIdToken = 'mock-id-token'; + mocks.ClerkGoogleOneTapSignIn.presentExplicitSignIn.mockResolvedValue({ + type: 'success', + data: { idToken: mockIdToken }, + }); + mocks.isSuccessResponse.mockReturnValue(true); + + mockSignIn.create.mockResolvedValue(undefined); + mockSignIn.firstFactorVerification.status = 'transferable'; + + const mockSignUpWithSession = { ...mockSignUp, createdSessionId: 'new-user-session-id' }; + mocks.useSignUp.mockReturnValue({ + signUp: mockSignUpWithSession, + isLoaded: true, + }); + + const { result } = renderHook(() => useSignInWithGoogle()); + + const response = await result.current.startGoogleAuthenticationFlow({ + unsafeMetadata: { source: 'test' }, + }); + + expect(mockSignIn.create).toHaveBeenCalledWith({ + strategy: 'google_one_tap', + token: mockIdToken, + }); + expect(mockSignUp.create).toHaveBeenCalledWith({ + transfer: true, + unsafeMetadata: { source: 'test' }, + }); + expect(response.createdSessionId).toBe('new-user-session-id'); + }); + + test('should handle user cancellation gracefully', async () => { + mocks.ClerkGoogleOneTapSignIn.presentExplicitSignIn.mockResolvedValue({ + type: 'cancelled', + data: null, + }); + mocks.isSuccessResponse.mockReturnValue(false); + + const { result } = renderHook(() => useSignInWithGoogle()); + + const response = await result.current.startGoogleAuthenticationFlow(); + + expect(response.createdSessionId).toBe(null); + expect(response.setActive).toBe(mockSetActive); + }); + + test('should handle SIGN_IN_CANCELLED error code', async () => { + const cancelError = Object.assign(new Error('User canceled'), { code: 'SIGN_IN_CANCELLED' }); + mocks.ClerkGoogleOneTapSignIn.presentExplicitSignIn.mockRejectedValue(cancelError); + + const { result } = renderHook(() => useSignInWithGoogle()); + + const response = await result.current.startGoogleAuthenticationFlow(); + + expect(response.createdSessionId).toBe(null); + expect(response.setActive).toBe(mockSetActive); + }); + + test('should return early when clerk is not loaded', async () => { + mocks.useSignIn.mockReturnValue({ + signIn: mockSignIn, + setActive: mockSetActive, + isLoaded: false, + }); + + const { result } = renderHook(() => useSignInWithGoogle()); + + const response = await result.current.startGoogleAuthenticationFlow(); + + expect(mocks.ClerkGoogleOneTapSignIn.configure).not.toHaveBeenCalled(); + expect(mocks.ClerkGoogleOneTapSignIn.presentExplicitSignIn).not.toHaveBeenCalled(); + expect(response.createdSessionId).toBe(null); + }); + + test('should fall back to signUp when external_account_not_found error occurs', async () => { + const mockIdToken = 'mock-id-token'; + mocks.ClerkGoogleOneTapSignIn.presentExplicitSignIn.mockResolvedValue({ + type: 'success', + data: { idToken: mockIdToken }, + }); + mocks.isSuccessResponse.mockReturnValue(true); + + // Mock signIn.create to throw external_account_not_found Clerk error + const externalAccountError = { + clerkError: true, + errors: [{ code: 'external_account_not_found' }], + message: 'External account not found', + }; + mockSignIn.create.mockRejectedValue(externalAccountError); + + // Mock signUp.create to succeed with a new session + const mockSignUpWithSession = { + ...mockSignUp, + create: vi.fn().mockResolvedValue(undefined), + createdSessionId: 'new-signup-session-id', + }; + mocks.useSignUp.mockReturnValue({ + signUp: mockSignUpWithSession, + isLoaded: true, + }); + + const { result } = renderHook(() => useSignInWithGoogle()); + + const response = await result.current.startGoogleAuthenticationFlow({ + unsafeMetadata: { referral: 'google' }, + }); + + // Verify signIn.create was called first + expect(mockSignIn.create).toHaveBeenCalledWith({ + strategy: 'google_one_tap', + token: mockIdToken, + }); + + // Verify signUp.create was called as fallback with the token + expect(mockSignUpWithSession.create).toHaveBeenCalledWith({ + strategy: 'google_one_tap', + token: mockIdToken, + unsafeMetadata: { referral: 'google' }, + }); + + // Verify the session was created + expect(response.createdSessionId).toBe('new-signup-session-id'); + expect(response.setActive).toBe(mockSetActive); + }); + }); +}); diff --git a/packages/expo/src/hooks/index.ts b/packages/expo/src/hooks/index.ts index f5fdd57daf2..05747be3351 100644 --- a/packages/expo/src/hooks/index.ts +++ b/packages/expo/src/hooks/index.ts @@ -12,6 +12,7 @@ export { } from '@clerk/react'; export * from './useSignInWithApple'; +export * from './useSignInWithGoogle'; export * from './useSSO'; export * from './useOAuth'; export * from './useAuth'; diff --git a/packages/expo/src/hooks/useSignInWithGoogle.android.ts b/packages/expo/src/hooks/useSignInWithGoogle.android.ts new file mode 100644 index 00000000000..71922944fd6 --- /dev/null +++ b/packages/expo/src/hooks/useSignInWithGoogle.android.ts @@ -0,0 +1,209 @@ +import { useSignIn, useSignUp } from '@clerk/react/legacy'; +import type { SetActive, SignInResource, SignUpResource } from '@clerk/shared/types'; +import Constants from 'expo-constants'; +import * as Crypto from 'expo-crypto'; + +import { ClerkGoogleOneTapSignIn, isSuccessResponse } from '../google-one-tap'; +import { errorThrower } from '../utils/errors'; + +type SignUpUnsafeMetadata = Record; + +export type StartGoogleAuthenticationFlowParams = { + unsafeMetadata?: SignUpUnsafeMetadata; +}; + +export type StartGoogleAuthenticationFlowReturnType = { + createdSessionId: string | null; + setActive?: SetActive; + signIn?: SignInResource; + signUp?: SignUpResource; +}; + +/** + * Hook for native Google Authentication on Android using Clerk's built-in Google One Tap module. + * + * This hook provides a simplified way to authenticate users with their Google account + * using the native Android Google Sign-In UI with Credential Manager. The authentication + * flow automatically handles the ID token exchange with Clerk's backend and manages + * the transfer flow between sign-in and sign-up. + * + * Features: + * - Native Google One Tap UI + * - Built-in nonce support for replay attack protection + * - No additional dependencies required + * + * @example + * ```tsx + * import { useSignInWithGoogle } from '@clerk/clerk-expo'; + * import { Button } from 'react-native'; + * + * function GoogleSignInButton() { + * const { startGoogleAuthenticationFlow } = useSignInWithGoogle(); + * + * const onPress = async () => { + * try { + * const { createdSessionId, setActive } = await startGoogleAuthenticationFlow(); + * + * if (createdSessionId && setActive) { + * await setActive({ session: createdSessionId }); + * } + * } catch (err) { + * console.error('Google Authentication error:', err); + * } + * }; + * + * return