@thoughtbot/react-native-social-auth 0.1.0 → 0.2.0

package/README.md

@@ -4,6 +4,8 @@ Drop-in Google Sign-In for React Native using Android's Credential Manager and t
 
 **Platform support:** ✅ Android · ✅ iOS
 
+> ⚠️ **Early development.** This package is pre-1.0 and under active development. The public API — configuration options, method signatures, `GoogleSignInButton` props, and error codes — may change between minor versions without a deprecation cycle. If you need stability, pin the exact version in `package.json` (`"@thoughtbot/react-native-social-auth": "0.x.y"`, not `"^0.x.y"`) and check the [CHANGELOG](CHANGELOG.md) before upgrading. We aim for a stable `1.0.0` once the API has been battle-tested.
+
 ## Features
 
 - Android **Credential Manager** and iOS **GoogleSignIn-iOS SDK** integration, both with auto-sign-in + interactive fallback
@@ -65,6 +67,8 @@ The Web client ID is what your code references for the ID-token audience; each p
 
 In addition to the Cloud Console step above, the host app needs two iOS-specific changes.
 
+> **Using Expo?** Skip the manual `Info.plist` and `AppDelegate` edits below — [our config plugin](#expo-config-plugin) handles them during `expo prebuild`. Bare React Native CLI users continue with the manual steps in this section.
+
 ### 1. Register the OAuth URL scheme
 
 Google routes the sign-in callback back into your app via a custom URL scheme. Add the reversed iOS Client ID to `Info.plist`:
@@ -85,29 +89,30 @@ If you use **Expo**, declare it in `app.json` under `expo.ios.infoPlist.CFBundle
 
 ### 2. Forward incoming URLs to the SDK
 
-In your `AppDelegate`, forward `application(_:open:options:)` to `GoogleSignIn.handleURL(_:)`.
+In your `AppDelegate`, forward `application(_:open:options:)` to `GIDSignIn.sharedInstance.handle(_:)`. Importing `GoogleSignIn` here pulls in the official GoogleSignIn-iOS SDK module (already a transitive dependency of this package).
 
 **Swift:**
 ```swift
-import react_native_social_auth
+import GoogleSignIn
 
-func application(
+@objc
+public func application(
   _ app: UIApplication,
   open url: URL,
   options: [UIApplication.OpenURLOptionsKey: Any] = [:]
 ) -> Bool {
-  return GoogleSignIn.handleURL(url)
+  return GIDSignIn.sharedInstance.handle(url)
 }
 ```
 
 **Objective-C:**
 ```objc
-#import <react_native_social_auth/GoogleSignIn.h>
+#import <GoogleSignIn/GoogleSignIn.h>
 
 - (BOOL)application:(UIApplication *)app
             openURL:(NSURL *)url
             options:(NSDictionary<UIApplicationOpenURLOptionsKey, id> *)options {
-  return [GoogleSignIn handleURL:url];
+  return [[GIDSignIn sharedInstance] handleURL:url];
 }
 ```
 
@@ -124,6 +129,56 @@ GoogleSignIn.configure({
 
 Finally, run `cd ios && pod install` after installing the package.
 
+## Expo config plugin
+
+This package ships an Expo config plugin so you don't have to hand-edit `Info.plist` or `AppDelegate` in Expo projects. **Both React Native CLI and Expo projects are supported** — pick the setup section that matches your project.
+
+> **Heads up:** Expo Go cannot ship third-party native modules. You must use a [development build](https://docs.expo.dev/develop/development-builds/introduction/) (via `expo-dev-client` and EAS Build) or the bare workflow.
+
+### Install
+
+```sh
+npx expo install @thoughtbot/react-native-social-auth react-native-svg
+```
+
+### Add the plugin
+
+In `app.config.ts` (or `app.json`):
+
+```ts
+export default {
+  expo: {
+    // ...
+    plugins: [
+      [
+        '@thoughtbot/react-native-social-auth',
+        {
+          iosClientId: process.env.EXPO_PUBLIC_GOOGLE_IOS_CLIENT_ID,
+        },
+      ],
+    ],
+  },
+};
+```
+
+### Plugin props
+
+| Prop          | Type     | Required for iOS | Description                                                                                                                       |
+| ------------- | -------- | ---------------- | --------------------------------------------------------------------------------------------------------------------------------- |
+| `iosClientId` | `string` | Yes              | Your iOS OAuth Client ID (e.g. `123456-abc.apps.googleusercontent.com`). The plugin reverses it and registers the URL scheme.     |
+
+Omit `iosClientId` if you only target Android — the plugin becomes a no-op on iOS and logs a warning.
+
+### Regenerate native code
+
+```sh
+npx expo prebuild --clean
+```
+
+This runs the plugin, which writes the reversed iOS Client ID into `Info.plist`'s `CFBundleURLSchemes` and adds the `application(_:open:options:)` URL forwarder to `AppDelegate`. Subsequent prebuilds are idempotent — the plugin won't re-inject if its marker is already present.
+
+You still call `GoogleSignIn.configure({ webClientId, iosClientId })` from JS at runtime (the plugin handles the native bits; it doesn't replace `configure()`).
+
 ## Quick start
 
 ```tsx
@@ -173,7 +228,7 @@ Stores credentials and options used by subsequent calls.
 | Field            | Type       | Required | Description                                                                                       |
 | ---------------- | ---------- | -------- | ------------------------------------------------------------------------------------------------- |
 | `webClientId`    | `string`   | Yes      | The **Web application** OAuth Client ID. This is the audience of the issued ID token.             |
-| `iosClientId`    | `string`   | No       | iOS OAuth Client ID (used once iOS support lands).                                                |
+| `iosClientId`    | `string`   | No       | iOS OAuth Client ID.                                                |
 | `offlineAccess`  | `boolean`  | No       | Request a server auth code in addition to the ID token. Default `false`.                          |
 | `scopes`         | `string[]` | No       | Additional OAuth scopes beyond the default profile/email.                                         |
 | `hostedDomain`   | `string`   | No       | Restrict sign-in to a Google Workspace domain.                                                    |

package/app.plugin.js

@@ -0,0 +1 @@
+module.exports = require('./plugin/build/withSocialAuth').default;

package/lib/typescript/plugin/src/withSocialAuth.d.ts

@@ -0,0 +1,28 @@
+import type { ConfigPlugin } from '@expo/config-plugins';
+export type SocialAuthPluginProps = {
+    /**
+     * The OAuth 2.0 iOS application client ID from Google Cloud Console
+     * (format: `*.apps.googleusercontent.com`). Required to register the
+     * URL scheme that GoogleSignIn-iOS uses for its OAuth callback.
+     *
+     * Omit for Android-only setups — the plugin becomes a no-op on iOS.
+     */
+    iosClientId?: string;
+};
+/**
+ * Compute the reversed iOS Client ID that GoogleSignIn-iOS expects as a
+ * `CFBundleURLSchemes` entry.
+ *
+ * Example:
+ *   `123-abc.apps.googleusercontent.com`
+ *     → `com.googleusercontent.apps.123-abc`
+ */
+/** @internal — exported for tests only. */
+export declare function reverseClientId(iosClientId: string): string;
+/** @internal — exported for tests only. */
+export declare function injectSwiftURLHandler(contents: string): string;
+/** @internal — exported for tests only. */
+export declare function injectObjCURLHandler(contents: string): string;
+declare const _default: ConfigPlugin<void | SocialAuthPluginProps>;
+export default _default;
+//# sourceMappingURL=withSocialAuth.d.ts.map

package/lib/typescript/plugin/src/withSocialAuth.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"withSocialAuth.d.ts","sourceRoot":"","sources":["../../../../plugin/src/withSocialAuth.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAIzD,MAAM,MAAM,qBAAqB,GAAG;IAClC;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAKF;;;;;;;GAOG;AACH,2CAA2C;AAC3C,wBAAgB,eAAe,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,CAS3D;AAyCD,2CAA2C;AAC3C,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CA8B9D;AAED,2CAA2C;AAC3C,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAyB7D;;AAyBD,wBAA6E"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thoughtbot/react-native-social-auth",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "OAuth sign in buttons and methods for React Native",
   "main": "./lib/module/index.js",
   "types": "./lib/typescript/src/index.d.ts",
@@ -10,7 +10,8 @@
       "types": "./lib/typescript/src/index.d.ts",
       "default": "./lib/module/index.js"
     },
-    "./package.json": "./package.json"
+    "./package.json": "./package.json",
+    "./app.plugin.js": "./app.plugin.js"
   },
   "files": [
     "src",
@@ -18,6 +19,8 @@
     "android",
     "ios",
     "cpp",
+    "plugin/build",
+    "app.plugin.js",
     "*.podspec",
     "react-native.config.js",
     "!ios/build",
@@ -33,11 +36,12 @@
   ],
   "scripts": {
     "example": "yarn workspace @thoughtbot/react-native-social-auth-example",
-    "clean": "del-cli lib",
-    "prepare": "bob build",
+    "clean": "del-cli lib plugin/build",
+    "prepare": "bob build && yarn build:plugin",
+    "build:plugin": "tsc --project plugin/tsconfig.json",
     "typecheck": "tsc",
     "test": "jest",
-    "release": "release-it --only-version",
+    "release": "release-it",
     "lint": "eslint \"**/*.{js,ts,tsx}\""
   },
   "keywords": [
@@ -60,19 +64,22 @@
   },
   "homepage": "https://github.com/thoughtbot/react-native-social-auth#readme",
   "publishConfig": {
-    "registry": "https://registry.npmjs.org/"
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
   },
   "devDependencies": {
     "@commitlint/config-conventional": "^20.5.0",
     "@eslint/compat": "^2.0.3",
     "@eslint/eslintrc": "^3.3.5",
     "@eslint/js": "^10.0.1",
+    "@expo/config-plugins": "^9",
     "@jest/globals": "^30.0.0",
     "@react-native/babel-preset": "0.85.0",
     "@react-native/eslint-config": "0.85.0",
     "@react-native/jest-preset": "0.85.0",
     "@release-it/conventional-changelog": "^10.0.6",
     "@testing-library/react-native": "^13.3",
+    "@types/node": "^26.0.1",
     "@types/react": "^19.2.0",
     "@types/react-test-renderer": "^19",
     "commitlint": "^20.5.0",
@@ -81,6 +88,7 @@
     "eslint-config-prettier": "^10.1.8",
     "eslint-plugin-ft-flow": "^3.0.11",
     "eslint-plugin-prettier": "^5.5.5",
+    "expo": "^56.0.12",
     "jest": "^30.3.0",
     "lefthook": "^2.1.4",
     "prettier": "^3.8.1",
@@ -94,10 +102,16 @@
     "typescript": "^6.0.2"
   },
   "peerDependencies": {
+    "@expo/config-plugins": ">=9.0.0",
     "react": "*",
     "react-native": "*",
     "react-native-svg": ">=13.0.0"
   },
+  "peerDependenciesMeta": {
+    "@expo/config-plugins": {
+      "optional": true
+    }
+  },
   "workspaces": [
     "example"
   ],
@@ -143,19 +157,33 @@
   "release-it": {
     "git": {
       "commitMessage": "chore: release ${version}",
-      "tagName": "v${version}"
+      "tagName": "v${version}",
+      "tagAnnotation": "Release ${version}",
+      "requireCleanWorkingDir": true,
+      "push": true
     },
     "npm": {
-      "publish": true
+      "publish": true,
+      "skipChecks": true
     },
     "github": {
-      "release": true
+      "release": true,
+      "releaseName": "v${version}"
+    },
+    "hooks": {
+      "before:init": [
+        "yarn lint",
+        "yarn typecheck",
+        "yarn test --maxWorkers=2"
+      ],
+      "after:bump": "yarn prepare"
     },
     "plugins": {
       "@release-it/conventional-changelog": {
         "preset": {
           "name": "angular"
-        }
+        },
+        "infile": "CHANGELOG.md"
       }
     }
   },

package/plugin/build/withSocialAuth.d.ts

@@ -0,0 +1,27 @@
+import type { ConfigPlugin } from '@expo/config-plugins';
+export type SocialAuthPluginProps = {
+    /**
+     * The OAuth 2.0 iOS application client ID from Google Cloud Console
+     * (format: `*.apps.googleusercontent.com`). Required to register the
+     * URL scheme that GoogleSignIn-iOS uses for its OAuth callback.
+     *
+     * Omit for Android-only setups — the plugin becomes a no-op on iOS.
+     */
+    iosClientId?: string;
+};
+/**
+ * Compute the reversed iOS Client ID that GoogleSignIn-iOS expects as a
+ * `CFBundleURLSchemes` entry.
+ *
+ * Example:
+ *   `123-abc.apps.googleusercontent.com`
+ *     → `com.googleusercontent.apps.123-abc`
+ */
+/** @internal — exported for tests only. */
+export declare function reverseClientId(iosClientId: string): string;
+/** @internal — exported for tests only. */
+export declare function injectSwiftURLHandler(contents: string): string;
+/** @internal — exported for tests only. */
+export declare function injectObjCURLHandler(contents: string): string;
+declare const _default: ConfigPlugin<void | SocialAuthPluginProps>;
+export default _default;

package/plugin/build/withSocialAuth.js

@@ -0,0 +1,119 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.reverseClientId = reverseClientId;
+exports.injectSwiftURLHandler = injectSwiftURLHandler;
+exports.injectObjCURLHandler = injectObjCURLHandler;
+const config_plugins_1 = require("@expo/config-plugins");
+const pkg = require('../../package.json');
+const PLUGIN_NAME = '@thoughtbot/react-native-social-auth';
+const MARKER = '/* @thoughtbot/react-native-social-auth: URL handler */';
+/**
+ * Compute the reversed iOS Client ID that GoogleSignIn-iOS expects as a
+ * `CFBundleURLSchemes` entry.
+ *
+ * Example:
+ *   `123-abc.apps.googleusercontent.com`
+ *     → `com.googleusercontent.apps.123-abc`
+ */
+/** @internal — exported for tests only. */
+function reverseClientId(iosClientId) {
+    const suffix = '.apps.googleusercontent.com';
+    if (!iosClientId.endsWith(suffix)) {
+        throw new Error(`[${PLUGIN_NAME}] iosClientId must end with "${suffix}". Received: "${iosClientId}".`);
+    }
+    const id = iosClientId.slice(0, -suffix.length);
+    return `com.googleusercontent.apps.${id}`;
+}
+const withGoogleSignInURLScheme = (config, { reversedClientId }) => {
+    return (0, config_plugins_1.withInfoPlist)(config, (mod) => {
+        var _a;
+        const urlTypes = ((_a = mod.modResults).CFBundleURLTypes ?? (_a.CFBundleURLTypes = []));
+        const alreadyRegistered = urlTypes.some((entry) => (entry.CFBundleURLSchemes ?? []).includes(reversedClientId));
+        if (!alreadyRegistered) {
+            urlTypes.push({
+                CFBundleURLSchemes: [reversedClientId],
+            });
+        }
+        return mod;
+    });
+};
+const withGoogleSignInAppDelegate = (config) => {
+    return (0, config_plugins_1.withAppDelegate)(config, (mod) => {
+        const { language, contents } = mod.modResults;
+        if (contents.includes(MARKER)) {
+            return mod;
+        }
+        if (language === 'swift') {
+            mod.modResults.contents = injectSwiftURLHandler(contents);
+        }
+        else if (language === 'objcpp' || language === 'objc') {
+            mod.modResults.contents = injectObjCURLHandler(contents);
+        }
+        else {
+            throw new Error(`[${PLUGIN_NAME}] Unknown AppDelegate language "${language}". Expected "swift" or "objcpp".`);
+        }
+        return mod;
+    });
+};
+/** @internal — exported for tests only. */
+function injectSwiftURLHandler(contents) {
+    const snippet = `
+  ${MARKER}
+  @objc
+  public func application(
+    _ app: UIApplication,
+    open url: URL,
+    options: [UIApplication.OpenURLOptionsKey: Any] = [:]
+  ) -> Bool {
+    return GIDSignIn.sharedInstance.handle(url)
+  }
+`;
+    const importLine = 'import GoogleSignIn';
+    let next = contents;
+    if (!next.includes(importLine)) {
+        next = next.replace(/(import ExpoModulesCore|import React|import Expo)/, `$1\n${importLine}`);
+    }
+    // Inject the override before the closing brace of the AppDelegate class.
+    const classCloseRegex = /\n\}\s*$/;
+    if (!classCloseRegex.test(next)) {
+        throw new Error(`[${PLUGIN_NAME}] Could not locate the AppDelegate class closing brace.`);
+    }
+    return next.replace(classCloseRegex, `\n${snippet}}\n`);
+}
+/** @internal — exported for tests only. */
+function injectObjCURLHandler(contents) {
+    const snippet = `
+${MARKER}
+- (BOOL)application:(UIApplication *)application
+            openURL:(NSURL *)url
+            options:(NSDictionary<UIApplicationOpenURLOptionsKey, id> *)options
+{
+  if ([[GIDSignIn sharedInstance] handleURL:url]) { return YES; }
+  return [super application:application openURL:url options:options];
+}
+`;
+    const importLine = '#import <GoogleSignIn/GoogleSignIn.h>';
+    let next = contents;
+    if (!next.includes(importLine)) {
+        next = next.replace(/(#import "AppDelegate\.h")/, `$1\n${importLine}`);
+    }
+    const endRegex = /\n@end\s*$/;
+    if (!endRegex.test(next)) {
+        throw new Error(`[${PLUGIN_NAME}] Could not locate the AppDelegate's @end directive.`);
+    }
+    return next.replace(endRegex, `\n${snippet}\n@end\n`);
+}
+const withSocialAuth = (config, props) => {
+    const iosClientId = props?.iosClientId;
+    if (!iosClientId) {
+        console.warn(`[${PLUGIN_NAME}] No iosClientId provided — skipping iOS configuration. ` +
+            'Android consumers can ignore this warning; iOS consumers must pass ' +
+            '{ iosClientId } in their app config plugin entry.');
+        return config;
+    }
+    const reversedClientId = reverseClientId(iosClientId);
+    config = withGoogleSignInURLScheme(config, { reversedClientId });
+    config = withGoogleSignInAppDelegate(config);
+    return config;
+};
+exports.default = (0, config_plugins_1.createRunOncePlugin)(withSocialAuth, PLUGIN_NAME, pkg.version);