refactor(auth)!: migrate to TypeScript and bring auth closer in alignment with firebase-js-sdk API

.github/scripts/compare-types/packages/auth/config.ts

@@ -0,0 +1,226 @@
+/**
+ * Known differences between the firebase-js-sdk @firebase/auth public
+ * API and the @react-native-firebase/auth modular API.
+ *
+ * Each entry must have a `name` and a `reason`. Any undocumented
+ * difference or stale entry will fail `yarn compare:types`.
+ */
+
+import type { PackageConfig } from '../../src/types';
+
+const config: PackageConfig = {
+  nameMapping: {},
+
+  missingInRN: [
+    {
+      name: 'initializeRecaptchaConfig',
+      reason:
+        'Web-only reCAPTCHA bootstrap helper from the firebase-js-sdk. RN Firebase does not expose browser reCAPTCHA initialization because native SDKs own the phone-auth verification flow.',
+    },
+    {
+      name: 'AuthErrorCodes',
+      reason:
+        'RN Firebase still relies on native auth error code strings and does not export the firebase-js-sdk AuthErrorCodes constant map.',
+    },
+    {
+      name: 'browserCookiePersistence',
+      reason:
+        'Browser-only persistence implementation from the firebase-js-sdk. Not applicable to React Native native-auth persistence.',
+    },
+    {
+      name: 'browserLocalPersistence',
+      reason:
+        'Browser-only localStorage persistence implementation from the firebase-js-sdk. Not applicable to React Native native-auth persistence.',
+    },
+    {
+      name: 'browserPopupRedirectResolver',
+      reason:
+        'Browser-only popup/redirect resolver from the firebase-js-sdk. Native provider flows do not use the browser popup resolver stack.',
+    },
+    {
+      name: 'browserSessionPersistence',
+      reason:
+        'Browser-only sessionStorage persistence implementation from the firebase-js-sdk. Not applicable to React Native native-auth persistence.',
+    },
+    {
+      name: 'debugErrorMap',
+      reason:
+        'firebase-js-sdk web error-map helper. RN Firebase does not expose the SDK error-map selection API.',
+    },
+    {
+      name: 'EmailAuthCredential',
+      reason:
+        'RN Firebase does not yet expose the firebase-js-sdk EmailAuthCredential class as part of the modular public surface.',
+    },
+    {
+      name: 'FacebookAuthProvider',
+      reason:
+        'This provider class is still only reachable through the legacy namespaced export path, not the modular compare-types surface.',
+    },
+    {
+      name: 'GithubAuthProvider',
+      reason:
+        'This provider class is still only reachable through the legacy namespaced export path, not the modular compare-types surface.',
+    },
+    {
+      name: 'GoogleAuthProvider',
+      reason:
+        'This provider class is still only reachable through the legacy namespaced export path, not the modular compare-types surface.',
+    },
+    {
+      name: 'indexedDBLocalPersistence',
+      reason:
+        'IndexedDB persistence is web-only and not applicable to React Native native-auth persistence.',
+    },
+    {
+      name: 'inMemoryPersistence',
+      reason:
+        'The firebase-js-sdk persistence object is not exported by RN Firebase because auth state is managed by the underlying native SDKs.',
+    },
+    {
+      name: 'OAuthCredential',
+      reason:
+        'RN Firebase does not yet expose the firebase-js-sdk OAuthCredential class as part of the modular public surface.',
+    },
+    {
+      name: 'OAuthCredentialOptions',
+      reason:
+        'RN Firebase does not yet export the firebase-js-sdk OAuthCredentialOptions interface.',
+    },
+    {
+      name: 'PhoneAuthCredential',
+      reason:
+        'RN Firebase does not yet expose the firebase-js-sdk PhoneAuthCredential class as part of the modular public surface.',
+    },
+    {
+      name: 'PhoneAuthProvider',
+      reason:
+        'This provider class is still only reachable through the legacy namespaced export path, not the modular compare-types surface.',
+    },
+    {
+      name: 'prodErrorMap',
+      reason:
+        'firebase-js-sdk web error-map helper. RN Firebase does not expose the SDK error-map selection API.',
+    },
+    {
+      name: 'ReactNativeAsyncStorage',
+      reason:
+        'The firebase-js-sdk React Native persistence helper type is not exported by RN Firebase because persistence is delegated to the native iOS/Android SDKs rather than configured through initializeAuth().',
+    },
+    {
+      name: 'RecaptchaParameters',
+      reason: 'Browser reCAPTCHA configuration is not part of the RN Firebase native auth surface.',
+    },
+    {
+      name: 'RecaptchaVerifier',
+      reason:
+        'Browser reCAPTCHA verifier implementation is not available in RN Firebase because native SDKs own application verification.',
+    },
+    {
+      name: 'SAMLAuthProvider',
+      reason:
+        'SAMLAuthProvider is not yet surfaced on the RN Firebase modular/public auth surface.',
+    },
+    {
+      name: 'TwitterAuthProvider',
+      reason:
+        'This provider class is still only reachable through the legacy namespaced export path, not the modular compare-types surface.',
+    },
+  ],
+
+  extraInRN: [
+    {
+      name: 'NativeFirebaseAuthError',
+      reason:
+        'RN Firebase-specific native bridge auth error type used in place of the firebase-js-sdk AuthError export.',
+    },
+    {
+      name: 'OIDCProvider',
+      reason:
+        'RN Firebase-specific OIDC provider class export retained for compatibility with the existing package surface.',
+    },
+    {
+      name: 'PhoneAuthState',
+      reason: 'RN Firebase-specific enum-like object describing native phone-auth listener states.',
+    },
+    {
+      name: 'PhoneAuthListener',
+      reason: 'RN Firebase-specific listener object returned by verifyPhoneNumber().',
+    },
+    {
+      name: 'PhoneAuthError',
+      reason:
+        'RN Firebase-specific phone verification error snapshot type used by native phone-auth listeners.',
+    },
+    {
+      name: 'PhoneAuthSnapshot',
+      reason:
+        'RN Firebase-specific phone verification snapshot type used by native phone-auth listeners.',
+    },
+    {
+      name: 'verifyPhoneNumber',
+      reason:
+        'RN Firebase-specific helper exposing the native phone verification listener flow; the firebase-js-sdk does not export this helper.',
+    },
+    {
+      name: 'setLanguageCode',
+      reason:
+        'RN Firebase keeps a modular helper for setting auth.languageCode, while the firebase-js-sdk only exposes the writable property.',
+    },
+    {
+      name: 'useUserAccessGroup',
+      reason:
+        'RN Firebase-specific iOS keychain sharing helper with no firebase-js-sdk equivalent.',
+    },
+    {
+      name: 'getCustomAuthDomain',
+      reason:
+        'RN Firebase-specific helper that exposes the configured native auth domain; no firebase-js-sdk equivalent exists.',
+    },
+  ],
+
+  differentShape: [
+    {
+      name: 'connectAuthEmulator',
+      reason:
+        'RN Firebase models disableWarnings as an optional property, while the firebase-js-sdk emitted type text shows a required boolean property.',
+    },
+    {
+      name: 'isSignInWithEmailLink',
+      reason:
+        'RN Firebase resolves this check asynchronously through the native bridge and returns Promise<boolean>, whereas the firebase-js-sdk returns a synchronous boolean.',
+    },
+    {
+      name: 'linkWithRedirect',
+      reason:
+        'Native provider flows resolve immediately with a UserCredential instead of following the browser redirect contract used by the firebase-js-sdk.',
+    },
+    {
+      name: 'reauthenticateWithRedirect',
+      reason:
+        'Native provider flows do not follow the browser redirect contract. RN Firebase models this as Promise<void> rather than the firebase-js-sdk Promise<never> signature.',
+    },
+    {
+      name: 'signInWithRedirect',
+      reason:
+        'Native provider flows resolve immediately with a UserCredential instead of following the browser redirect contract used by the firebase-js-sdk.',
+    },
+    {
+      name: 'updatePhoneNumber',
+      reason:
+        'RN Firebase accepts the broader AuthCredential surface, while the firebase-js-sdk narrows this parameter to PhoneAuthCredential.',
+    },
+    {
+      name: 'Auth',
+      reason:
+        'The public Auth surface now matches structurally, but the emitted declaration text still differs from the firebase-js-sdk because RN Firebase uses its local FirebaseApp and NextOrObserver<User> spellings in the generated interface.',
+    },
+    {
+      name: 'ParsedToken',
+      reason:
+        'TypeScript emits the parsed-token property keys without quotes in the generated declaration file, so compare-types reports a text-only difference even though the property set matches the firebase-js-sdk surface.',
+    },
+  ],
+};
+
+export default config;

.github/scripts/compare-types/src/registry.ts

@@ -15,6 +15,7 @@ import type { PackageConfig } from './types';
 
 import storageConfig from '../packages/storage/config';
 import aiConfig from '../packages/ai/config';
+import authConfig from '../packages/auth/config';
 import firestoreConfig from '../packages/firestore/config';
 import firestorePipelinesConfig from '../packages/firestore-pipelines/config';
 
@@ -45,17 +46,44 @@ export interface PackageEntry {
 }
 
 function rnDist(packageName: string): string {
-  return path.join(
-    REPO_ROOT,
-    'packages',
-    packageName,
-    'dist',
-    'typescript',
-    'lib',
-  );
+  return path.join(REPO_ROOT, 'packages', packageName, 'dist', 'typescript', 'lib');
 }
 
 export const packages: PackageEntry[] = [
+  {
+    name: 'auth',
+    firebaseSdkTypesPaths: [path.join(SCRIPT_DIR, 'packages', 'auth', 'auth-js-sdk.d.ts')],
+    rnFirebaseModularFiles: [
+      path.join(rnDist('auth'), 'types', 'auth.d.ts'),
+      path.join(rnDist('auth'), 'modular.d.ts'),
+    ],
+    rnFirebaseSupportFiles: [
+      path.join(rnDist('auth'), 'index.d.ts'),
+      path.join(rnDist('auth'), 'namespaced.d.ts'),
+      path.join(rnDist('auth'), 'types', 'namespaced.d.ts'),
+      path.join(rnDist('auth'), 'types', 'internal.d.ts'),
+      path.join(rnDist('auth'), 'ConfirmationResult.d.ts'),
+      path.join(rnDist('auth'), 'MultiFactorResolver.d.ts'),
+      path.join(rnDist('auth'), 'PhoneAuthListener.d.ts'),
+      path.join(rnDist('auth'), 'PhoneMultiFactorGenerator.d.ts'),
+      path.join(rnDist('auth'), 'Settings.d.ts'),
+      path.join(rnDist('auth'), 'TotpMultiFactorGenerator.d.ts'),
+      path.join(rnDist('auth'), 'TotpSecret.d.ts'),
+      path.join(rnDist('auth'), 'User.d.ts'),
+      path.join(rnDist('auth'), 'getMultiFactorResolver.d.ts'),
+      path.join(rnDist('auth'), 'multiFactor.d.ts'),
+      path.join(rnDist('auth'), 'providers', 'AppleAuthProvider.d.ts'),
+      path.join(rnDist('auth'), 'providers', 'EmailAuthProvider.d.ts'),
+      path.join(rnDist('auth'), 'providers', 'FacebookAuthProvider.d.ts'),
+      path.join(rnDist('auth'), 'providers', 'GithubAuthProvider.d.ts'),
+      path.join(rnDist('auth'), 'providers', 'GoogleAuthProvider.d.ts'),
+      path.join(rnDist('auth'), 'providers', 'OAuthProvider.d.ts'),
+      path.join(rnDist('auth'), 'providers', 'OIDCAuthProvider.d.ts'),
+      path.join(rnDist('auth'), 'providers', 'PhoneAuthProvider.d.ts'),
+      path.join(rnDist('auth'), 'providers', 'TwitterAuthProvider.d.ts'),
+    ],
+    config: authConfig,
+  },
   // {
   //   name: 'remote-config',
   //   firebaseSdkTypesPaths: [
@@ -74,12 +102,7 @@ export const packages: PackageEntry[] = [
   // },
   {
     name: 'storage',
-    firebaseSdkTypesPaths: [path.join(
-      SCRIPT_DIR,
-      'packages',
-      'storage',
-      'storage-js-sdk.d.ts',
-    )],
+    firebaseSdkTypesPaths: [path.join(SCRIPT_DIR, 'packages', 'storage', 'storage-js-sdk.d.ts')],
     rnFirebaseModularFiles: [
       path.join(rnDist('storage'), 'types', 'storage.d.ts'),
       path.join(rnDist('storage'), 'modular.d.ts'),
@@ -93,12 +116,8 @@ export const packages: PackageEntry[] = [
   },
   {
     name: 'ai',
-    firebaseSdkTypesPaths: [
-      path.join(SCRIPT_DIR, 'packages', 'ai', 'ai-sdk.d.ts'),
-    ],
-    rnFirebaseModularFiles: [
-      path.join(rnDist('ai'), 'index.d.ts'),
-    ],
+    firebaseSdkTypesPaths: [path.join(SCRIPT_DIR, 'packages', 'ai', 'ai-sdk.d.ts')],
+    rnFirebaseModularFiles: [path.join(rnDist('ai'), 'index.d.ts')],
     rnFirebaseSupportFiles: [
       path.join(rnDist('ai'), 'backend.d.ts'),
       path.join(rnDist('ai'), 'errors.d.ts'),
@@ -132,12 +151,7 @@ export const packages: PackageEntry[] = [
   {
     name: 'firestore',
     firebaseSdkTypesPaths: [
-      path.join(
-        SCRIPT_DIR,
-        'packages',
-        'firestore',
-        'firestore-js-sdk.d.ts',
-      ),
+      path.join(SCRIPT_DIR, 'packages', 'firestore', 'firestore-js-sdk.d.ts'),
     ],
     rnFirebaseModularFiles: [
       path.join(rnDist('firestore'), 'types', 'firestore.d.ts'),
@@ -174,16 +188,9 @@ export const packages: PackageEntry[] = [
   {
     name: 'firestore-pipelines',
     firebaseSdkTypesPaths: [
-      path.join(
-        SCRIPT_DIR,
-        'packages',
-        'firestore-pipelines',
-        'pipelines.d.ts',
-      ),
-    ],
-    rnFirebaseModularFiles: [
-      path.join(rnDist('firestore'), 'pipelines', 'index.d.ts'),
+      path.join(SCRIPT_DIR, 'packages', 'firestore-pipelines', 'pipelines.d.ts'),
     ],
+    rnFirebaseModularFiles: [path.join(rnDist('firestore'), 'pipelines', 'index.d.ts')],
     rnFirebaseSupportFiles: [
       path.join(rnDist('firestore'), 'pipelines', 'expressions.d.ts'),
       path.join(rnDist('firestore'), 'pipelines', 'pipeline.d.ts'),
@@ -197,5 +204,3 @@ export const packages: PackageEntry[] = [
     config: firestorePipelinesConfig,
   },
 ];
-
-

packages/auth/lib/ConfirmationResult.js → packages/auth/lib/ConfirmationResult.ts

@@ -1,3 +1,4 @@
+// @ts-nocheck
 /*
  * Copyright (c) 2016-present Invertase Limited & Contributors
  *

packages/auth/lib/MultiFactorResolver.js → packages/auth/lib/MultiFactorResolver.ts

@@ -1,3 +1,4 @@
+// @ts-nocheck
 /**
  * Base class to facilitate multi-factor authentication.
  */

packages/auth/lib/PhoneAuthListener.js → packages/auth/lib/PhoneAuthListener.ts

@@ -1,3 +1,4 @@
+// @ts-nocheck
 /*
  * Copyright (c) 2016-present Invertase Limited & Contributors
  *

packages/auth/lib/PhoneMultiFactorGenerator.js → packages/auth/lib/PhoneMultiFactorGenerator.ts

@@ -1,3 +1,4 @@
+// @ts-nocheck
 /*
  * Copyright (c) 2016-present Invertase Limited & Contributors
  *

packages/auth/lib/Settings.js → packages/auth/lib/Settings.ts

@@ -1,3 +1,4 @@
+// @ts-nocheck
 /*
  * Copyright (c) 2016-present Invertase Limited & Contributors
  *

packages/auth/lib/TotpMultiFactorGenerator.js → packages/auth/lib/TotpMultiFactorGenerator.ts

@@ -1,3 +1,4 @@
+// @ts-nocheck
 /*
  * Copyright (c) 2016-present Invertase Limited & Contributors
  *

packages/auth/lib/TotpSecret.js → packages/auth/lib/TotpSecret.ts

@@ -1,3 +1,4 @@
+// @ts-nocheck
 /*
  * Copyright (c) 2016-present Invertase Limited & Contributors
  *
@@ -60,7 +61,7 @@ export class TotpSecret {
    * @param qrCodeUrl the URL to open in the app, from generateQrCodeUrl
    */
   openInOtpApp(qrCodeUrl) {
-    if (isString(qrCodeUrl) && !qrCodeUrl !== '') {
+    if (isString(qrCodeUrl) && qrCodeUrl !== '') {
       return this.auth.native.openInOtpApp(this.secretKey, qrCodeUrl);
     }
   }