react-native-oauth-essentials 1.0.11 → 1.1.1

package/ios/RCTPromiseSettler.swift

@@ -1,4 +1,6 @@
+import AuthenticationServices
 import React
+import UIKit
 
 public typealias EventEmitter = ((_ eventName: String, _ body: [String: Any]) -> Void)?
 public class RCTPromiseSettler: NSObject {
@@ -20,9 +22,132 @@ public class RCTPromiseSettler: NSObject {
     return self.resolve == nil && self.reject == nil
   }
 
+  internal func succeed(_ result: [String: Any]) {
+    self.resolve?(result)
+    self.emitEvent?("onCredentialSuccess", result as NSDictionary)
+    cleanup()
+  }
+
+  internal func fail(_ code: CredentialError, _ message: String, _ error: Error? = nil) {
+    self.reject?(code.rawValue, message, error)
+    self.emitEvent?("onCredentialFailure", [
+      "code": code.rawValue,
+      "message": message
+    ])
+    cleanup()
+  }
+
   internal func cleanup() -> Void {
     self.resolve = nil
     self.reject = nil
     self.emitEvent = nil
   }
+
+  /// ASAuthorizationController failure: a cancellation resolves as CANCELLED, anything else rejects.
+  internal func finish(authorizationError error: Error) {
+    let nsError = error as NSError
+    if nsError.domain == ASAuthorizationError.errorDomain,
+       nsError.code == ASAuthorizationError.canceled.rawValue {
+      succeed(CredentialFactory.fromCancelled())
+    } else {
+      fail(.invalidResult, error.localizedDescription, error)
+    }
+  }
+
+  /// Checks what ASWebAuthenticationSession (also used by GoogleSignIn) needs to start: no Guided
+  /// Access, the app active (waiting up to `browserActiveTimeout`) and a view controller in a
+  /// foreground active scene. A failed start is then reported as BROWSER_UNAVAILABLE without relying
+  /// on the error the session returns. Calls `open` with that view controller, or fails.
+  internal func whenBrowserCanOpen(_ name: String, _ open: @escaping (UIViewController) -> Void) {
+    if UIAccessibility.isGuidedAccessEnabled {
+      fail(.browserUnavailable, "\(name) cannot open the browser while Guided Access is enabled")
+      return
+    }
+
+    PresentationContext.whenActive(timeout: Self.browserActiveTimeout) { active in
+      guard active else {
+        self.fail(.browserUnavailable, "\(name) requires the app to be active")
+        return
+      }
+      guard let presenter = PresentationContext.topViewController() else {
+        self.fail(.noActivity, "No view controller available to present \(name)")
+        return
+      }
+      guard presenter.view.window?.windowScene?.activationState == .foregroundActive else {
+        self.fail(.browserUnavailable, "\(name) cannot open the browser: the app window is not in the foreground")
+        return
+      }
+      open(presenter)
+    }
+  }
+
+  /// How long to wait for the app to become active before giving up on opening the browser.
+  private static let browserActiveTimeout: TimeInterval = 2
+}
+
+/// Finds where to present the sign in UI. Must be called on the main thread.
+enum PresentationContext {
+
+  static func activeWindowScene() -> UIWindowScene? {
+    let scenes = UIApplication.shared.connectedScenes.compactMap { $0 as? UIWindowScene }
+    return scenes.first { $0.activationState == .foregroundActive }
+      ?? scenes.first { $0.activationState == .foregroundInactive }
+  }
+
+  static func activeWindow() -> UIWindow? {
+    guard let scene = activeWindowScene() else { return nil }
+    return scene.windows.first { $0.isKeyWindow }
+      ?? scene.windows.first { !$0.isHidden && $0.windowLevel == .normal }
+  }
+
+  /// The top most view controller that is attached to a window.
+  static func topViewController() -> UIViewController? {
+    var top = activeWindow()?.rootViewController
+    while let presented = top?.presentedViewController, !presented.isBeingDismissed {
+      top = presented
+    }
+    guard let viewController = top, viewController.viewIfLoaded?.window != nil else {
+      return nil
+    }
+    return viewController
+  }
+
+  static func anchor() -> ASPresentationAnchor {
+    if let window = activeWindow() {
+      return window
+    }
+    if let scene = activeWindowScene() {
+      return UIWindow(windowScene: scene)
+    }
+    return ASPresentationAnchor()
+  }
+
+  /// Calls completion(true) once the app is active, or completion(false) after the timeout.
+  static func whenActive(timeout: TimeInterval, _ completion: @escaping (Bool) -> Void) {
+    if UIApplication.shared.applicationState == .active {
+      completion(true)
+      return
+    }
+
+    var observer: NSObjectProtocol?
+    var finished = false
+    let finish: (Bool) -> Void = { active in
+      if finished { return }
+      finished = true
+      if let observer = observer {
+        NotificationCenter.default.removeObserver(observer)
+      }
+      completion(active)
+    }
+
+    observer = NotificationCenter.default.addObserver(
+      forName: UIApplication.didBecomeActiveNotification,
+      object: nil,
+      queue: .main
+    ) { _ in finish(true) }
+
+    DispatchQueue.main.asyncAfter(deadline: .now() + timeout) {
+      finish(UIApplication.shared.applicationState == .active)
+    }
+  }
 }

package/jest/index.js

@@ -0,0 +1,149 @@
+/* global jest */
+/**
+ * Jest mock of react-native-oauth-essentials. Every method is a `jest.fn()` resolving a plausible
+ * result; override it per test with `mockResolvedValueOnce` / `mockRejectedValueOnce`.
+ *
+ *   jest.mock('react-native-oauth-essentials', () =>
+ *     require('react-native-oauth-essentials/jest')
+ *   );
+ *
+ * Plain CommonJS on purpose: the React Native Jest preset does not transform this package.
+ */
+
+const CredentialsType = {
+  GOOGLE_ID: 'GOOGLE_ID',
+  PASSWORD: 'PASSWORD',
+  APPLE_ID: 'APPLE_ID',
+  WEB_APPLE_ID: 'WEB_APPLE_ID',
+  CANCELLED: 'CANCELLED',
+  PASSKEY: 'PASSKEY',
+  OAUTH: 'OAUTH',
+};
+
+const AppleIdCredentialState = {
+  AUTHORIZED: 'AUTHORIZED',
+  REVOKED: 'REVOKED',
+  NOT_FOUND: 'NOT_FOUND',
+  TRANSFERRED: 'TRANSFERRED',
+};
+
+const CredentialError = {
+  NO_PLAY_SERVICES_ERROR: 'NO_PLAY_SERVICES_ERROR',
+  NO_ACTIVITY_ERROR: 'NO_ACTIVITY_ERROR',
+  INVALID_RESULT_ERROR: 'INVALID_RESULT_ERROR',
+  NO_SIGN_IN_AVAILABLE: 'NO_SIGN_IN_AVAILABLE',
+  SIMULTANEOUS_CALL_ERROR: 'SIMULTANEOUS_CALL_ERROR',
+  NOT_SUPPORTED_ERROR: 'NOT_SUPPORTED_ERROR',
+  BROWSER_UNAVAILABLE: 'BROWSER_UNAVAILABLE',
+  CONFIGURATION_ERROR: 'CONFIGURATION_ERROR',
+  NETWORK_ERROR: 'NETWORK_ERROR',
+};
+
+const CODES = new Set(Object.values(CredentialError));
+
+function isCredentialError(error, code) {
+  if (typeof error !== 'object' || error === null) {
+    return false;
+  }
+  const value = error.code;
+  if (typeof value !== 'string' || !CODES.has(value)) {
+    return false;
+  }
+  return code === undefined || value === code;
+}
+
+const OAUTH_REDIRECT_URI = 'com.example.app://oauth/callback';
+
+const googleResult = () => ({
+  type: CredentialsType.GOOGLE_ID,
+  data: {
+    id: 'mock-google-id',
+    idToken: 'mock-google-id-token',
+    displayName: 'Mock User',
+    givenName: 'Mock',
+    familyName: 'User',
+    email: 'mock.user@example.com',
+    profilePictureUri: null,
+    phoneNumber: null,
+    accessToken: null,
+    serverAuthCode: null,
+    grantedScopes: null,
+  },
+});
+
+const appleResult = () => ({
+  type: CredentialsType.APPLE_ID,
+  data: {
+    idToken: 'mock-apple-id-token',
+    authorizationCode: 'mock-apple-authorization-code',
+    user: 'mock-apple-user',
+    email: 'mock.user@example.com',
+    fullName: 'Mock User',
+    likelyReal: true,
+    state: null,
+  },
+});
+
+const passwordResult = () => ({
+  type: CredentialsType.PASSWORD,
+  data: { username: 'mock.user@example.com', password: 'mock-password' },
+});
+
+const passkeyResult = () => ({
+  type: CredentialsType.PASSKEY,
+  data: JSON.stringify({ id: 'mock-passkey', type: 'public-key' }),
+});
+
+const subscription = () => ({ remove: jest.fn() });
+
+module.exports = {
+  __esModule: true,
+
+  // Methods
+  googleSignIn: jest.fn(async () => googleResult()),
+  googleSilentSignIn: jest.fn(async () => googleResult()),
+  signOut: jest.fn(async () => true),
+  getPassword: jest.fn(async () => passwordResult()),
+  passwordSignIn: jest.fn(async () => true),
+  appleSignIn: jest.fn(async () => appleResult()),
+  getAppleIdCredentialState: jest.fn(
+    async () => AppleIdCredentialState.AUTHORIZED
+  ),
+  hybridSignIn: jest.fn(async () => googleResult()),
+  createPassKey: jest.fn(async () => passkeyResult()),
+  getPassKey: jest.fn(async () => passkeyResult()),
+  cancelPassKeyAutoFill: jest.fn(async () => false),
+  oauthSignIn: jest.fn(async (options) => ({
+    type: CredentialsType.OAUTH,
+    data: {
+      code: 'mock-authorization-code',
+      state: 'mock-state',
+      redirectUri: (options && options.redirectUri) || OAUTH_REDIRECT_URI,
+      codeVerifier: 'mock-code-verifier',
+      params: { code: 'mock-authorization-code', state: 'mock-state' },
+      tokens: null,
+    },
+  })),
+
+  // Events
+  addCredentialSuccessListener: jest.fn(subscription),
+  addCredentialFailureListener: jest.fn(subscription),
+  addAppleIdCredentialRevokedListener: jest.fn(subscription),
+
+  // Errors
+  isCredentialError,
+
+  // Enums
+  CredentialsType,
+  AppleIdCredentialState,
+  CredentialError,
+
+  // Constants
+  GOOGLE_PLAY_SERVICES_SUPPORTED: true,
+  PASSWORD_SUPPORTED: true,
+  GOOGLE_ID_SUPPORTED: true,
+  APPLE_ID_SUPPORTED: true,
+  HYBRID_SUPPORTED: true,
+  PASSKEYS_SUPPORTED: true,
+  OAUTH_REDIRECT_URI,
+};

package/lib/module/NativeOauthEssentials.js

@@ -1,5 +1,14 @@
 "use strict";
 
 import { TurboModuleRegistry } from 'react-native';
-export default TurboModuleRegistry.getEnforcing('OauthEssentials');
+import { missingNativeModuleMessage } from "./platform.js";
+// `get` instead of `getEnforcing` to explain Expo Go and missing rebuilds instead of a generic error.
+function getNativeModule() {
+  const module = TurboModuleRegistry.get('OauthEssentials');
+  if (!module) {
+    throw new Error(missingNativeModuleMessage());
+  }
+  return module;
+}
+export default getNativeModule();
 //# sourceMappingURL=NativeOauthEssentials.js.map

package/lib/module/NativeOauthEssentials.js.map

@@ -1 +1 @@
-{"version":3,"names":["TurboModuleRegistry","getEnforcing"],"sourceRoot":"../../src","sources":["NativeOauthEssentials.ts"],"mappings":";;AAAA,SAGEA,mBAAmB,QACd,cAAc;AA4DrB,eAAeA,mBAAmB,CAACC,YAAY,CAAO,iBAAiB,CAAC","ignoreList":[]}
+{"version":3,"names":["TurboModuleRegistry","missingNativeModuleMessage","getNativeModule","module","get","Error"],"sourceRoot":"../../src","sources":["NativeOauthEssentials.ts"],"mappings":";;AAAA,SAGEA,mBAAmB,QACd,cAAc;AACrB,SAASC,0BAA0B,QAAQ,eAAY;AAwHvD;AACA,SAASC,eAAeA,CAAA,EAAS;EAC/B,MAAMC,MAAM,GAAGH,mBAAmB,CAACI,GAAG,CAAO,iBAAiB,CAAC;EAC/D,IAAI,CAACD,MAAM,EAAE;IACX,MAAM,IAAIE,KAAK,CAACJ,0BAA0B,CAAC,CAAC,CAAC;EAC/C;EACA,OAAOE,MAAM;AACf;AAEA,eAAeD,eAAe,CAAC,CAAC","ignoreList":[]}

package/lib/module/errors.js

@@ -0,0 +1,38 @@
+"use strict";
+
+import { CredentialError } from "./types.js";
+const CODES = new Set(Object.values(CredentialError));
+
+/**
+ * Narrows an unknown error (e.g. in a `catch`) to an error rejected by this library, optionally
+ * with a specific code.
+ *
+ * ```ts
+ * try {
+ *   await googleSignIn({ iosClientId, webClientId });
+ * } catch (e) {
+ *   if (isCredentialError(e, CredentialError.BROWSER_UNAVAILABLE)) retryLater();
+ *   else if (isCredentialError(e)) report(e.code, e.message);
+ *   else throw e;
+ * }
+ * ```
+ */
+export function isCredentialError(error, code) {
+  if (typeof error !== 'object' || error === null) {
+    return false;
+  }
+  const value = error.code;
+  if (typeof value !== 'string' || !CODES.has(value)) {
+    return false;
+  }
+  return code === undefined || value === code;
+}
+export function createCredentialError(code, message, cause) {
+  const error = new Error(message);
+  error.code = code;
+  if (cause !== undefined) {
+    error.cause = cause;
+  }
+  return error;
+}
+//# sourceMappingURL=errors.js.map

package/lib/module/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["CredentialError","CODES","Set","Object","values","isCredentialError","error","code","value","has","undefined","createCredentialError","message","cause","Error"],"sourceRoot":"../../src","sources":["errors.ts"],"mappings":";;AAAA,SACEA,eAAe,QAGV,YAAS;AAEhB,MAAMC,KAAK,GAAG,IAAIC,GAAG,CAASC,MAAM,CAACC,MAAM,CAACJ,eAAe,CAAC,CAAC;;AAE7D;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASK,iBAAiBA,CAE/BC,KAAc,EAAEC,IAAQ,EAAoC;EAC5D,IAAI,OAAOD,KAAK,KAAK,QAAQ,IAAIA,KAAK,KAAK,IAAI,EAAE;IAC/C,OAAO,KAAK;EACd;EACA,MAAME,KAAK,GAAIF,KAAK,CAAwBC,IAAI;EAChD,IAAI,OAAOC,KAAK,KAAK,QAAQ,IAAI,CAACP,KAAK,CAACQ,GAAG,CAACD,KAAK,CAAC,EAAE;IAClD,OAAO,KAAK;EACd;EACA,OAAOD,IAAI,KAAKG,SAAS,IAAIF,KAAK,KAAKD,IAAI;AAC7C;AAEA,OAAO,SAASI,qBAAqBA,CACnCJ,IAAO,EACPK,OAAe,EACfC,KAAe,EACU;EACzB,MAAMP,KAAK,GAAG,IAAIQ,KAAK,CAACF,OAAO,CAE9B;EACDN,KAAK,CAACC,IAAI,GAAGA,IAAI;EACjB,IAAIM,KAAK,KAAKH,SAAS,EAAE;IACvBJ,KAAK,CAACO,KAAK,GAAGA,KAAK;EACrB;EACA,OAAOP,KAAK;AACd","ignoreList":[]}