@react-native-firebase/auth 24.1.1 → 25.0.0

package/lib/credentials/OAuthCredential.ts

@@ -0,0 +1,113 @@
+/*
+ * Copyright (c) 2016-present Invertase Limited & Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this library except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+import { AuthCredential, parseCredentialJSON } from './AuthCredential';
+
+type OAuthCredentialJSON = {
+  providerId?: string;
+  signInMethod?: string;
+  idToken?: string;
+  accessToken?: string;
+  rawNonce?: string;
+  nonce?: string;
+  secret?: string;
+};
+
+type OAuthCredentialParams = {
+  idToken?: string;
+  accessToken?: string;
+  rawNonce?: string;
+  secret?: string;
+  /** @internal RNFB native bridge token slot override */
+  bridgeToken?: string;
+  /** @internal RNFB native bridge secret slot override */
+  bridgeSecret?: string;
+};
+
+function resolveOAuthBridgeFields(params: OAuthCredentialParams): { token: string; secret: string } {
+  if (params.bridgeToken !== undefined || params.bridgeSecret !== undefined) {
+    return {
+      token: params.bridgeToken ?? '',
+      secret: params.bridgeSecret ?? '',
+    };
+  }
+
+  if (params.idToken) {
+    return {
+      token: params.idToken,
+      secret: params.rawNonce ?? params.secret ?? params.accessToken ?? '',
+    };
+  }
+
+  if (params.accessToken) {
+    // OAuthProvider access-token-only credentials use the secret bridge slot.
+    return {
+      token: '',
+      secret: params.accessToken,
+    };
+  }
+
+  return {
+    token: params.secret ?? '',
+    secret: params.rawNonce ?? '',
+  };
+}
+
+export class OAuthCredential extends AuthCredential {
+  readonly idToken?: string;
+  readonly accessToken?: string;
+  /** @remarks Used for Sign in with Apple and Facebook limited-login flows. OAuth 1.0 token secrets (e.g. Twitter) use the inherited AuthCredential secret bridge field instead. */
+  readonly rawNonce?: string;
+
+  constructor(providerId: string, params: OAuthCredentialParams) {
+    const bridge = resolveOAuthBridgeFields(params);
+    super(providerId, providerId, bridge.token, bridge.secret);
+    this.idToken = params.idToken;
+    this.accessToken = params.accessToken;
+    this.rawNonce = params.rawNonce;
+  }
+
+  toJSON(): object {
+    const json: Record<string, unknown> = {
+      providerId: this.providerId,
+      signInMethod: this.signInMethod,
+      idToken: this.idToken,
+      accessToken: this.accessToken,
+      rawNonce: this.rawNonce,
+      nonce: this.rawNonce,
+    };
+    // Twitter (and similar) store the token secret in the native bridge secret slot, not rawNonce.
+    if (this.secret && !this.rawNonce) {
+      json.secret = this.secret;
+    }
+    return json;
+  }
+
+  static fromJSON(json: object | string): OAuthCredential | null {
+    const parsed = parseCredentialJSON(json) as OAuthCredentialJSON | null;
+    if (!parsed || typeof parsed.providerId !== 'string') {
+      return null;
+    }
+
+    return new OAuthCredential(parsed.providerId, {
+      idToken: parsed.idToken,
+      accessToken: parsed.accessToken,
+      rawNonce: parsed.rawNonce ?? parsed.nonce,
+      secret: parsed.secret,
+    });
+  }
+}

package/lib/credentials/PhoneAuthCredential.ts

@@ -0,0 +1,66 @@
+/*
+ * Copyright (c) 2016-present Invertase Limited & Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this library except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+import { AuthCredential, parseCredentialJSON } from './AuthCredential';
+
+const providerId = 'phone' as const;
+
+type PhoneCredentialJSON = {
+  providerId?: string;
+  signInMethod?: string;
+  verificationId?: string;
+  verificationCode?: string;
+  temporaryProof?: string;
+  phoneNumber?: string;
+};
+
+export class PhoneAuthCredential extends AuthCredential {
+  constructor(verificationId: string, verificationCode: string) {
+    super(providerId, providerId, verificationId, verificationCode);
+  }
+
+  toJSON(): object {
+    return {
+      verificationId: this.token,
+      verificationCode: this.secret,
+      providerId: this.providerId,
+      signInMethod: this.signInMethod,
+    };
+  }
+
+  static fromJSON(json: object | string): PhoneAuthCredential | null {
+    const parsed = parseCredentialJSON(json) as PhoneCredentialJSON | null;
+    if (!parsed) {
+      return null;
+    }
+
+    const verificationId = parsed.verificationId;
+    const verificationCode = parsed.verificationCode;
+    if (typeof verificationId !== 'string' || typeof verificationCode !== 'string') {
+      return null;
+    }
+
+    return new PhoneAuthCredential(verificationId, verificationCode);
+  }
+}
+
+export function createPhoneAuthCredential(
+  verificationId: string,
+  verificationCode: string,
+): PhoneAuthCredential {
+  return new PhoneAuthCredential(verificationId, verificationCode);
+}

package/lib/{providers/GithubAuthProvider.js → credentials/index.ts}

@@ -15,22 +15,7 @@
  *
  */
 
-const providerId = 'github.com';
-
-export default class GithubAuthProvider {
-  constructor() {
-    throw new Error('`new GithubAuthProvider()` is not supported on the native Firebase SDKs.');
-  }
-
-  static get PROVIDER_ID() {
-    return providerId;
-  }
-
-  static credential(token) {
-    return {
-      token,
-      secret: '',
-      providerId,
-    };
-  }
-}
+export { AuthCredential, parseCredentialJSON } from './AuthCredential';
+export { EmailAuthCredential, createEmailAuthCredential } from './EmailAuthCredential';
+export { OAuthCredential } from './OAuthCredential';
+export { PhoneAuthCredential, createPhoneAuthCredential } from './PhoneAuthCredential';

package/lib/getMultiFactorResolver.ts

@@ -0,0 +1,40 @@
+import { isOther } from '@react-native-firebase/app/dist/module/common';
+import MultiFactorResolver from './MultiFactorResolver';
+import type { FirebaseAuthTypes } from './types/namespaced';
+import type { AuthInternal } from './types/internal';
+
+type ErrorWithResolver = FirebaseAuthTypes.MultiFactorError & {
+  userInfo?: {
+    resolver?: {
+      hints: FirebaseAuthTypes.MultiFactorResolver['hints'];
+      session: FirebaseAuthTypes.MultiFactorResolver['session'];
+    };
+  };
+};
+
+/**
+ * Create a new resolver based on an auth instance and error
+ * object.
+ *
+ * Returns null if no resolver object can be found on the error.
+ */
+export function getMultiFactorResolver(
+  auth: AuthInternal,
+  error: ErrorWithResolver,
+): FirebaseAuthTypes.MultiFactorResolver | null {
+  if (isOther) {
+    return auth.native.getMultiFactorResolver(error) as FirebaseAuthTypes.MultiFactorResolver | null;
+  }
+  if (
+    error.hasOwnProperty('userInfo') &&
+    error.userInfo?.hasOwnProperty('resolver') &&
+    error.userInfo.resolver
+  ) {
+    return new MultiFactorResolver(
+      auth,
+      error.userInfo.resolver,
+    ) as unknown as FirebaseAuthTypes.MultiFactorResolver;
+  }
+
+  return null;
+}

package/lib/{providers/TwitterAuthProvider.js → index.ts}

@@ -14,23 +14,18 @@
  * limitations under the License.
  *
  */
+// modular API
+export type * from './types/auth';
+export { ActionCodeURL } from './ActionCodeURL';
+export {
+  AuthCredential,
+  EmailAuthCredential,
+  OAuthCredential,
+  PhoneAuthCredential,
+} from './credentials';
+export * from './modular';
 
-const providerId = 'twitter.com';
-
-export default class TwitterAuthProvider {
-  constructor() {
-    throw new Error('`new TwitterAuthProvider()` is not supported on the native Firebase SDKs.');
-  }
-
-  static get PROVIDER_ID() {
-    return providerId;
-  }
-
-  static credential(token, secret) {
-    return {
-      token,
-      secret,
-      providerId,
-    };
-  }
-}
+// namespaced API
+export * from './types/namespaced';
+export * from './namespaced';
+export { default } from './namespaced';