react-native-oauth-essentials 1.0.2

package/lib/typescript/src/types.d.ts

@@ -0,0 +1,71 @@
+export type GoogleSignInOptions = {
+    authorizedAccounts?: boolean;
+    autoSelectEnabled?: boolean;
+};
+export type PasskeyOptions = {
+    requestJson: string;
+    preferImmediatelyAvailableCredentials?: boolean;
+    isConditional?: boolean;
+};
+export type PassKeyCredentialResult = {
+    type: CredentialsType.PASSKEY;
+    data: string;
+};
+export type PasswordCredentialResult = {
+    type: CredentialsType.PASSWORD;
+    data: {
+        username: string;
+        password: string;
+    };
+};
+export type GoogleIdCredentialResult = {
+    type: CredentialsType.GOOGLE_ID;
+    data: {
+        id: string;
+        idToken: string;
+        displayName: string;
+        givenName: string;
+        familyName: string;
+        profilePictureUri?: string | null;
+        phoneNumber?: string | null;
+    };
+};
+export type CancelledCredentialResult = {
+    type: CredentialsType.CANCELLED;
+    data: null;
+};
+export type AppleIdCredentialResult = {
+    type: CredentialsType.APPLE_ID;
+    data: {
+        idToken: string;
+        authorizationCode: string;
+        user: string;
+        email: string;
+        fullName: string;
+        likelyReal: boolean;
+    };
+};
+export type WebAppleIdCredentialResult = {
+    type: CredentialsType.WEB_APPLE_ID;
+    data: {
+        url: string;
+        scheme: string | null;
+        host: string | null;
+        path: string | null;
+        query: string | null;
+    };
+};
+export declare enum CredentialsType {
+    GOOGLE_ID = "GOOGLE_ID",// GoogleId credentials type
+    PASSWORD = "PASSWORD",// Password credentials type
+    APPLE_ID = "APPLE_ID",// IOS AppleId credentials type
+    WEB_APPLE_ID = "WEB_APPLE_ID",// Android AppleId credentials type
+    CANCELLED = "CANCELLED",// type when the user cancels it
+    PASSKEY = "PASSKEY"
+}
+export declare enum CredentialError {
+    NO_PLAY_SERVICES_ERROR = "NO_PLAY_SERVICES_ERROR",
+    NO_ACTIVITY_ERROR = "NO_ACTIVITY_ERROR",
+    INVALID_RESULT_ERROR = "INVALID_RESULT_ERROR"
+}
+//# sourceMappingURL=types.d.ts.map

package/lib/typescript/src/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,mBAAmB,GAAG;IAChC,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,WAAW,EAAE,MAAM,CAAC;IACpB,qCAAqC,CAAC,EAAE,OAAO,CAAC;IAChD,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,IAAI,EAAE,eAAe,CAAC,OAAO,CAAC;IAC9B,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,IAAI,EAAE,eAAe,CAAC,QAAQ,CAAC;IAC/B,IAAI,EAAE;QACJ,QAAQ,EAAE,MAAM,CAAC;QACjB,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,IAAI,EAAE,eAAe,CAAC,SAAS,CAAC;IAChC,IAAI,EAAE;QACJ,EAAE,EAAE,MAAM,CAAC;QACX,OAAO,EAAE,MAAM,CAAC;QAChB,WAAW,EAAE,MAAM,CAAC;QACpB,SAAS,EAAE,MAAM,CAAC;QAClB,UAAU,EAAE,MAAM,CAAC;QACnB,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAClC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC7B,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,IAAI,EAAE,eAAe,CAAC,SAAS,CAAC;IAChC,IAAI,EAAE,IAAI,CAAC;CACZ,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,IAAI,EAAE,eAAe,CAAC,QAAQ,CAAC;IAC/B,IAAI,EAAE;QACJ,OAAO,EAAE,MAAM,CAAC;QAChB,iBAAiB,EAAE,MAAM,CAAC;QAC1B,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;QACd,QAAQ,EAAE,MAAM,CAAC;QACjB,UAAU,EAAE,OAAO,CAAC;KACrB,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG;IACvC,IAAI,EAAE,eAAe,CAAC,YAAY,CAAC;IACnC,IAAI,EAAE;QACJ,GAAG,EAAE,MAAM,CAAC;QACZ,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;QACtB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QACpB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QACpB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;KACtB,CAAC;CACH,CAAC;AAEF,oBAAY,eAAe;IACzB,SAAS,cAAc,CAAE,4BAA4B;IACrD,QAAQ,aAAa,CAAE,4BAA4B;IACnD,QAAQ,aAAa,CAAE,+BAA+B;IACtD,YAAY,iBAAiB,CAAE,mCAAmC;IAClE,SAAS,cAAc,CAAE,gCAAgC;IACzD,OAAO,YAAY;CACpB;AAED,oBAAY,eAAe;IACzB,sBAAsB,2BAA2B;IACjD,iBAAiB,sBAAsB;IACvC,oBAAoB,yBAAyB;CAC9C"}

package/package.json

@@ -0,0 +1,156 @@
+{
+  "name": "react-native-oauth-essentials",
+  "version": "1.0.2",
+  "description": "Essential oauth tools for every app.need.",
+  "main": "./lib/module/index.js",
+  "types": "./lib/typescript/src/index.d.ts",
+  "exports": {
+    ".": {
+      "source": "./src/index.tsx",
+      "types": "./lib/typescript/src/index.d.ts",
+      "default": "./lib/module/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "src",
+    "lib",
+    "android",
+    "ios",
+    "cpp",
+    "*.podspec",
+    "react-native.config.js",
+    "!ios/build",
+    "!android/build",
+    "!android/gradle",
+    "!android/gradlew",
+    "!android/gradlew.bat",
+    "!android/local.properties",
+    "!**/__tests__",
+    "!**/__fixtures__",
+    "!**/__mocks__",
+    "!**/.*"
+  ],
+  "scripts": {
+    "example": "yarn workspace react-native-oauth-essentials-example",
+    "clean": "del-cli android/build example/android/build example/android/app/build example/ios/build lib",
+    "prepare": "bob build",
+    "typecheck": "tsc",
+    "lint": "eslint \"**/*.{js,ts,tsx}\"",
+    "test": "jest",
+    "prerelease": "yarn typecheck && yarn lint && yarn test",
+    "release": "release-it",
+    "release:patch": "release-it patch",
+    "release:minor": "release-it minor",
+    "release:major": "release-it major",
+    "release:dry": "release-it --dry-run"
+  },
+  "keywords": [
+    "react-native",
+    "ios",
+    "android"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/lucaswitch/react-native-oauth-essentials.git"
+  },
+  "author": "Lucas Alves <lucas.developing@gmail.com> (https://github.com/lucaswitch)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/lucaswitch/react-native-oauth-essentials/issues"
+  },
+  "homepage": "https://github.com/lucaswitch/react-native-oauth-essentials#readme",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "devDependencies": {
+    "@commitlint/config-conventional": "^19.8.1",
+    "@eslint/compat": "^1.3.2",
+    "@eslint/eslintrc": "^3.3.1",
+    "@eslint/js": "^9.35.0",
+    "@react-native/babel-preset": "0.83.0",
+    "@react-native/eslint-config": "0.83.0",
+    "@release-it/conventional-changelog": "10.0.1",
+    "@types/jest": "^29.5.14",
+    "@types/react": "^19.2.0",
+    "commitlint": "^19.8.1",
+    "del-cli": "^6.0.0",
+    "eslint": "^9.35.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-prettier": "^5.5.4",
+    "jest": "^29.7.0",
+    "lefthook": "^2.0.3",
+    "prettier": "^2.8.8",
+    "react": "19.2.0",
+    "react-native": "0.83.0",
+    "react-native-builder-bob": "^0.40.13",
+    "release-it": "^19.0.4",
+    "turbo": "^2.5.6",
+    "typescript": "^5.9.2"
+  },
+  "peerDependencies": {
+    "react": "*",
+    "react-native": "*"
+  },
+  "workspaces": [
+    "example",
+    "docs"
+  ],
+  "packageManager": "yarn@4.11.0",
+  "react-native-builder-bob": {
+    "source": "src",
+    "output": "lib",
+    "targets": [
+      [
+        "module",
+        {
+          "esm": true
+        }
+      ],
+      [
+        "typescript",
+        {
+          "project": "tsconfig.build.json"
+        }
+      ]
+    ]
+  },
+  "codegenConfig": {
+    "name": "OauthEssentialsSpec",
+    "type": "modules",
+    "jsSrcsDir": "src",
+    "android": {
+      "javaPackageName": "com.oauthessentials"
+    }
+  },
+  "prettier": {
+    "quoteProps": "consistent",
+    "singleQuote": true,
+    "tabWidth": 2,
+    "trailingComma": "es5",
+    "useTabs": false
+  },
+  "jest": {
+    "preset": "react-native",
+    "modulePathIgnorePatterns": [
+      "<rootDir>/example/node_modules",
+      "<rootDir>/lib/"
+    ]
+  },
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
+  },
+  "create-react-native-library": {
+    "type": "turbo-module",
+    "languages": "kotlin-objc",
+    "tools": [
+      "eslint",
+      "jest",
+      "lefthook",
+      "release-it"
+    ],
+    "version": "0.57.0"
+  }
+}

package/src/NativeOauthEssentials.ts

@@ -0,0 +1,75 @@
+import {
+  type CodegenTypes,
+  type TurboModule,
+  TurboModuleRegistry,
+} from 'react-native';
+
+export interface Spec extends TurboModule {
+  // Events
+  readonly onCredentialSuccess: CodegenTypes.EventEmitter<CredentialSuccessEvent>;
+  readonly onCredentialFailure: CodegenTypes.EventEmitter<CredentialErrorEvent>;
+
+  getConstants(): {
+    readonly GOOGLE_PLAY_SERVICES_SUPPORTED: boolean;
+    readonly PASSWORD_SUPPORTED: boolean;
+    readonly GOOGLE_ID_SUPPORTED: boolean;
+    readonly APPLE_ID_SUPPORTED: boolean;
+    readonly HYBRID_SUPPORTED: boolean;
+    readonly PASSKEYS_SUPPORTED: boolean;
+  };
+
+  /**
+   * Performs the google sign in.
+   * @param androidAndIOSClientId
+   * @param options
+   */
+  googleSignIn(androidAndIOSClientId: string, options: Object): Promise<Object>;
+
+  /**
+   * Sign ins with apple.
+   * @param androidWebUrl
+   */
+  appleSignIn(androidWebUrl?: string): Promise<Object>;
+
+  /**
+   * Saves the username/password credential
+   * @param username
+   * @param password
+   */
+  passwordSignIn(username: string, password: string): Promise<boolean>;
+
+  /**
+   * Gets the saved password.
+   */
+  getPassword(): Promise<Object>;
+
+  /**
+   * Performs the called so "hybrid sign in"
+   * @param googleClientId
+   * @param options
+   */
+  hybridSignIn(googleClientId: string, options: Object): Promise<Object>;
+
+  /**
+   * Creates the passkey.
+   */
+  createPassKey(options: Object): Promise<Object>;
+
+  /**
+   * Gets the passkey
+   * @param options
+   */
+  getPassKey(options: Object): Promise<Object>;
+}
+
+export default TurboModuleRegistry.getEnforcing<Spec>('OauthEssentials');
+
+type CredentialSuccessEvent = {
+  type: string;
+  data: Object;
+};
+
+type CredentialErrorEvent = {
+  code: string;
+  message: string;
+};

package/src/index.tsx

@@ -0,0 +1,199 @@
+import OauthEssentials from './NativeOauthEssentials';
+import { Platform } from 'react-native';
+import {
+  type AppleIdCredentialResult,
+  type CancelledCredentialResult,
+  CredentialsType,
+  type GoogleIdCredentialResult,
+  type GoogleSignInOptions,
+  type PassKeyCredentialResult,
+  type PasskeyOptions,
+  type PasswordCredentialResult,
+  type WebAppleIdCredentialResult,
+} from './types';
+
+export * from './types';
+const APPLE_ID_CACHED_RESULTS = new Map<
+  string,
+  AppleIdCredentialResult['data']
+>();
+
+/**
+ * Performs the google sign in.
+ * @param webClientId
+ * @param options
+ *
+ * You should rely on GOOGLE_ID_SUPPORTED constant to check if you can use this method.
+ * [Available on Android and IOS].
+ */
+export async function googleSignIn(
+  webClientId: string,
+  options?: GoogleSignInOptions
+): Promise<GoogleIdCredentialResult | CancelledCredentialResult> {
+  return (await OauthEssentials.googleSignIn(
+    webClientId,
+    parseGoogleIdOptions(options)
+  )) as GoogleIdCredentialResult;
+}
+
+/**
+ * Gets the stored password.
+ * If does not have an stored password, returns false.
+ *
+ * You should rely on PASSWORD_SUPPORTED constant to check if you can use this method.
+ * [Available on Android and IOS].
+ */
+export async function getPassword(): Promise<false | PasswordCredentialResult> {
+  const result = await OauthEssentials.getPassword();
+  return (result as PasswordCredentialResult) || false;
+}
+
+/**
+ * Performs the password sign in.
+ * Cannot be a already stored password.
+ * @param {string} username
+ * @param {string} password
+ *
+ * You should rely on PASSWORD_SUPPORTED constant to check if you can use this method.
+ * [Available on Android and IOS].
+ */
+export async function passwordSignIn(
+  username: string,
+  password: string
+): Promise<boolean> {
+  return await OauthEssentials.passwordSignIn(username, password);
+}
+
+/**
+ * Initiates the Apple Sign-In process.
+ * On IOS devices it handles it smoothly using the latest UI workflow.
+ * On Android it dispatches the androidWebUrl to device default browser for handling it.
+ * you need to implement on your backend the redirect logic and validation accordingly to the link below
+ * @see [Apple Sign In REST API Documentation](https://developer.apple.com/documentation/signinwithapplerestapi)
+ *
+ * @param {string} androidWebUrl - The web URL on Android where the user will complete the OAuth flow. **[Android only]**
+ *
+ * @returns {AppleIdCredentialResult|WebAppleIdCredentialResult} Returns AppleIdCredentialResult on IOS devices and WebAppleIdCredentialResult on android.
+ */
+export async function appleSignIn(
+  androidWebUrl?: string
+): Promise<AppleIdCredentialResult | WebAppleIdCredentialResult> {
+  const result = (await OauthEssentials.appleSignIn(
+    Platform.select({
+      ios: undefined,
+      android: androidWebUrl,
+    })
+  )) as AppleIdCredentialResult | WebAppleIdCredentialResult;
+  if (result.type === CredentialsType.APPLE_ID) {
+    if (APPLE_ID_CACHED_RESULTS.has(result.data.user)) {
+      // Reuse the fullName and email provided
+      const cached = APPLE_ID_CACHED_RESULTS.get(
+        result.data.user
+      ) as AppleIdCredentialResult['data'];
+
+      const data = result.data;
+      if (!data.fullName) {
+        data.fullName = cached.fullName;
+      }
+      if (!data.email) {
+        data.email = cached.email;
+      }
+    } else {
+      APPLE_ID_CACHED_RESULTS.set(result.data.user, result.data);
+    }
+    return result as AppleIdCredentialResult;
+  } else {
+    return result as WebAppleIdCredentialResult;
+  }
+}
+
+/**
+ * Performs all sign in methods available on the platform at once.
+ * This is supposed to be used on app start to get any existing sign in.
+ */
+export async function hybridSignIn(
+  googleClientId: string,
+  options?: GoogleSignInOptions
+): Promise<
+  | AppleIdCredentialResult
+  | GoogleIdCredentialResult
+  | PasswordCredentialResult
+  | CancelledCredentialResult
+> {
+  return (await OauthEssentials.hybridSignIn(
+    googleClientId,
+    parseGoogleIdOptions(options)
+  )) as
+    | AppleIdCredentialResult
+    | GoogleIdCredentialResult
+    | PasswordCredentialResult;
+}
+
+/**
+ * Creates a passkey.
+ * @param options
+ */
+export async function createPassKey(
+  options: PasskeyOptions
+): Promise<PassKeyCredentialResult> {
+  return (await OauthEssentials.createPassKey(
+    options
+  )) as PassKeyCredentialResult;
+}
+
+function parseGoogleIdOptions(options?: any) {
+  const bridgeOptions: GoogleSignInOptions = {
+    authorizedAccounts: false,
+    autoSelectEnabled: false,
+  };
+
+  const hasOptions =
+    options && typeof options === 'object' && Object.keys(options).length > 0;
+
+  if (hasOptions) {
+    if (Platform.OS === 'android') {
+      if (options.hasOwnProperty('authorizedAccounts')) {
+        bridgeOptions.authorizedAccounts = options.authorizedAccounts === true;
+      }
+      if (options.hasOwnProperty('autoSelectEnabled')) {
+        bridgeOptions.autoSelectEnabled = options.autoSelectEnabled === true;
+      }
+    }
+  }
+  return bridgeOptions;
+}
+
+const CONSTANTS = OauthEssentials.getConstants();
+
+/**
+ * Google Play are supported.
+ * It always false on IOS, cause IOS does not use Google Play Services.
+ */
+export const GOOGLE_PLAY_SERVICES_SUPPORTED =
+  CONSTANTS.GOOGLE_PLAY_SERVICES_SUPPORTED;
+
+/**
+ * The password method is supported.
+ */
+export const PASSWORD_SUPPORTED = CONSTANTS.PASSWORD_SUPPORTED;
+
+/**
+ * Google Play id sign in is supported.
+ * You should mainly rely on this constant to check if you can use google sign in.
+ */
+export const GOOGLE_ID_SUPPORTED = CONSTANTS.GOOGLE_ID_SUPPORTED;
+
+/**
+ * Gets if Apple id sign in is supported.
+ */
+export const APPLE_ID_SUPPORTED = CONSTANTS.APPLE_ID_SUPPORTED;
+
+/**
+ * Gets if "hybrid" is supported in this platform.
+ */
+export const HYBRID_SUPPORTED = CONSTANTS.HYBRID_SUPPORTED;
+
+/**
+ * Gets if passkeys are supported.
+ */
+export const PASSKEYS_SUPPORTED = CONSTANTS.PASSKEYS_SUPPORTED;

package/src/types.ts

@@ -0,0 +1,79 @@
+export type GoogleSignInOptions = {
+  authorizedAccounts?: boolean;
+  autoSelectEnabled?: boolean;
+};
+
+export type PasskeyOptions = {
+  requestJson: string;
+  preferImmediatelyAvailableCredentials?: boolean; // [Android only]
+  isConditional?: boolean; // [Android only]
+};
+
+export type PassKeyCredentialResult = {
+  type: CredentialsType.PASSKEY;
+  data: string; // JSON platform public key
+};
+
+export type PasswordCredentialResult = {
+  type: CredentialsType.PASSWORD;
+  data: {
+    username: string;
+    password: string;
+  };
+};
+
+export type GoogleIdCredentialResult = {
+  type: CredentialsType.GOOGLE_ID;
+  data: {
+    id: string;
+    idToken: string;
+    displayName: string;
+    givenName: string;
+    familyName: string;
+    profilePictureUri?: string | null;
+    phoneNumber?: string | null;
+  };
+};
+
+export type CancelledCredentialResult = {
+  type: CredentialsType.CANCELLED;
+  data: null;
+};
+
+export type AppleIdCredentialResult = {
+  type: CredentialsType.APPLE_ID;
+  data: {
+    idToken: string;
+    authorizationCode: string;
+    user: string;
+    email: string;
+    fullName: string;
+    likelyReal: boolean;
+  };
+};
+
+export type WebAppleIdCredentialResult = {
+  type: CredentialsType.WEB_APPLE_ID;
+  data: {
+    url: string;
+    scheme: string | null;
+    host: string | null;
+    path: string | null;
+    query: string | null;
+  };
+};
+
+export enum CredentialsType {
+  GOOGLE_ID = 'GOOGLE_ID', // GoogleId credentials type
+  PASSWORD = 'PASSWORD', // Password credentials type
+  APPLE_ID = 'APPLE_ID', // IOS AppleId credentials type
+  WEB_APPLE_ID = 'WEB_APPLE_ID', // Android AppleId credentials type
+  CANCELLED = 'CANCELLED', // type when the user cancels it
+  PASSKEY = 'PASSKEY', // Passkey credential type
+}
+
+export enum CredentialError {
+  NO_PLAY_SERVICES_ERROR = 'NO_PLAY_SERVICES_ERROR',
+  NO_ACTIVITY_ERROR = 'NO_ACTIVITY_ERROR',
+  INVALID_RESULT_ERROR = 'INVALID_RESULT_ERROR',
+}