feat!: migrate to TurboModules

.github/scripts/compare-types/configs/app-check.ts

@@ -89,7 +89,8 @@ const config: PackageConfig = {
     {
       name: 'initializeAppCheck',
       reason:
-        'RN Firebase returns `Promise<AppCheck>` because App Check initialization crosses the native bridge, whereas the firebase-js-sdk returns `AppCheck` synchronously.',
+        'RN Firebase returns `Promise<AppCheck>` whereas the firebase-js-sdk returns `AppCheck` synchronously. ' +
+        'Phase S hint: **Promise that could maybe sync-void+queue** after provider/refresh state is installed synchronously (see PS-S2-gap).',
     },
     {
       name: 'AppCheckOptions',

.github/scripts/compare-types/configs/app-distribution.ts

@@ -0,0 +1,31 @@
+/**
+ * Known differences between the firebase-js-sdk public API and
+ * the @react-native-firebase/app-distribution modular API.
+ *
+ * Each entry must have a `name` and a `reason`. Undocumented drift fails CI.
+ */
+
+import type { PackageConfig } from '../src/types';
+
+const config: PackageConfig = {
+  nameMapping: {},
+
+  missingInRN: [
+  ],
+
+  extraInRN: [
+    { name: 'getAppDistribution', reason: 'RN Firebase export for the native app-distribution module. The firebase-js-sdk does not ship a modular public API for this product.' },
+    { name: 'isTesterSignedIn', reason: 'RN Firebase export for the native app-distribution module. The firebase-js-sdk does not ship a modular public API for this product.' },
+    { name: 'signInTester', reason: 'RN Firebase export for the native app-distribution module. The firebase-js-sdk does not ship a modular public API for this product.' },
+    { name: 'checkForUpdate', reason: 'RN Firebase export for the native app-distribution module. The firebase-js-sdk does not ship a modular public API for this product.' },
+    { name: 'signOutTester', reason: 'RN Firebase export for the native app-distribution module. The firebase-js-sdk does not ship a modular public API for this product.' },
+    { name: 'SDK_VERSION', reason: 'RN Firebase package version string exported from the modular entry point. The firebase-js-sdk does not export SDK_VERSION from @firebase/app-distribution.' },
+    { name: 'AppDistribution', reason: 'RN Firebase export for the native app-distribution module. The firebase-js-sdk does not ship a modular public API for this product.' },
+    { name: 'AppDistributionRelease', reason: 'RN Firebase export for the native app-distribution module. The firebase-js-sdk does not ship a modular public API for this product.' },
+  ],
+
+  differentShape: [
+  ],
+};
+
+export default config;

.github/scripts/compare-types/configs/app.ts

@@ -0,0 +1,144 @@
+/**
+ * Known differences between firebase-js-sdk @firebase/app and
+ * @react-native-firebase/app 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: 'initializeServerApp',
+      reason:
+        'firebase-js-sdk server-side rendering entry point. Not applicable to React Native.',
+    },
+    {
+      name: 'FirebaseAppSettings',
+      reason:
+        'Settings type for firebase-js-sdk `FirebaseServerApp`. RN Firebase has no server-app API.',
+    },
+    {
+      name: 'FirebaseError',
+      reason:
+        'firebase-js-sdk base error class. RN Firebase uses `ReactNativeFirebase.NativeFirebaseError` from the native bridge instead.',
+    },
+    {
+      name: 'FirebaseOptions',
+      reason:
+        'firebase-js-sdk options interface. RN Firebase uses `ReactNativeFirebase.FirebaseAppOptions` (extends the same fields with RN-specific optional keys).',
+    },
+    {
+      name: 'FirebaseServerApp',
+      reason:
+        'firebase-js-sdk server-side app instance type. Not applicable to React Native.',
+    },
+    {
+      name: 'FirebaseServerAppSettings',
+      reason:
+        'Settings type for firebase-js-sdk server apps. Not applicable to React Native.',
+    },
+  ],
+
+  extraInRN: [
+    {
+      name: 'setReactNativeAsyncStorage',
+      reason:
+        'RN Firebase-specific hook to wire `@react-native-async-storage/async-storage` into the firebase-js-sdk Other/Hermes persistence path.',
+    },
+    {
+      name: 'metaGetAll',
+      reason:
+        'RN Firebase native bridge helper — reads all entries from the native Firebase metadata store.',
+    },
+    {
+      name: 'jsonGetAll',
+      reason:
+        'RN Firebase native bridge helper — reads all entries from the native JSON config store.',
+    },
+    {
+      name: 'preferencesClearAll',
+      reason:
+        'RN Firebase native bridge helper — clears native shared preferences used by Firebase.',
+    },
+    {
+      name: 'preferencesGetAll',
+      reason:
+        'RN Firebase native bridge helper — reads all native shared preference entries.',
+    },
+    {
+      name: 'preferencesSetBool',
+      reason:
+        'RN Firebase native bridge helper — sets a native boolean preference.',
+    },
+    {
+      name: 'preferencesSetString',
+      reason:
+        'RN Firebase native bridge helper — sets a native string preference.',
+    },
+    {
+      name: 'getUtils',
+      reason:
+        'RN Firebase entry point for the native Utils module (Play Services, file paths, etc.). No firebase-js-sdk modular equivalent.',
+    },
+    {
+      name: 'FilePath',
+      reason:
+        'RN Firebase native device file-path constants for Storage and similar file-based APIs.',
+    },
+    {
+      name: 'LogCallbackParams',
+      reason:
+        'RN Firebase log-handler callback payload type exported for modular `setLogLevel` wiring.',
+    },
+    {
+      name: 'LogCallback',
+      reason:
+        'RN Firebase log-handler callback type exported for modular logging configuration.',
+    },
+    {
+      name: 'LogOptions',
+      reason:
+        'RN Firebase log-handler options type exported for modular logging configuration.',
+    },
+  ],
+
+  differentShape: [
+    {
+      name: 'deleteApp',
+      reason:
+        'Parameter type is `ReactNativeFirebase.FirebaseApp` instead of firebase-js-sdk `FirebaseApp`. Runtime behavior matches.',
+    },
+    {
+      name: 'getApp',
+      reason:
+        'Return type is `ReactNativeFirebase.FirebaseApp` instead of firebase-js-sdk `FirebaseApp`. Runtime behavior matches.',
+    },
+    {
+      name: 'getApps',
+      reason:
+        'Return type is `ReactNativeFirebase.FirebaseApp[]` instead of firebase-js-sdk `FirebaseApp[]`. Runtime behavior matches.',
+    },
+    {
+      name: 'initializeApp',
+      reason:
+        'Returns `Promise<ReactNativeFirebase.FirebaseApp>` because initialization crosses the native bridge. Accepts `ReactNativeFirebase.FirebaseAppOptions` and optional `ReactNativeFirebase.FirebaseAppConfig` (name / auth domain) instead of firebase-js-sdk `(FirebaseOptions, string)` only.',
+    },
+    {
+      name: 'setLogLevel',
+      reason:
+        'Parameter type is `ReactNativeFirebase.LogLevelString` instead of firebase-js-sdk `LogLevelString`. Accepted values match (`debug`, `verbose`, `info`, `warn`, `error`, `silent`).',
+    },
+    {
+      name: 'FirebaseApp',
+      reason:
+        'RN Firebase exports the `ReactNativeFirebase.FirebaseApp` class/interface from shared app declarations instead of re-exporting firebase-js-sdk `FirebaseApp`.',
+    },
+  ],
+};
+
+export default config;

.github/scripts/compare-types/configs/auth.ts

@@ -204,11 +204,6 @@ const config: PackageConfig = {
       reason:
         'RN Firebase modular UserCredential includes optional enumerable additionalUserInfo (firebase-js-sdk core fields plus preserved native bridge keys). firebase-js-sdk keeps additionalUserInfo off the public UserCredential interface — use getAdditionalUserInfo there.',
     },
-    {
-      name: 'isSignInWithEmailLink',
-      reason:
-        'iOS/Android: Promise<boolean> via native bridge. Other/All: not aligned yet; firebase-js-sdk synchronous boolean is possible on Other/Hermes and Other/Web.',
-    },
     {
       name: 'linkWithRedirect',
       reason:
@@ -241,8 +236,7 @@ const config: PackageConfig = {
     },
     {
       name: 'TotpSecret',
-      reason:
-        'iOS/Android: generateQrCodeUrl is Promise<string> via native bridge; openInOtpApp is an RN-only helper. Other/All: js-sdk synchronous generateQrCodeUrl is possible when MFA is supported on Other.',
+      reason: 'RN Firebase extension: openInOtpApp is an RN-only helper.',
     },
     {
       name: 'User',

.github/scripts/compare-types/configs/crashlytics.ts

@@ -0,0 +1,39 @@
+/**
+ * Known differences between the firebase-js-sdk public API and
+ * the @react-native-firebase/crashlytics modular API.
+ *
+ * Each entry must have a `name` and a `reason`. Undocumented drift fails CI.
+ */
+
+import type { PackageConfig } from '../src/types';
+
+const config: PackageConfig = {
+  nameMapping: {},
+
+  missingInRN: [
+  ],
+
+  extraInRN: [
+    { name: 'getCrashlytics', reason: 'RN Firebase export for the native crashlytics module. The firebase-js-sdk does not ship a modular public API for this product.' },
+    { name: 'checkForUnsentReports', reason: 'RN Firebase export for the native crashlytics module. The firebase-js-sdk does not ship a modular public API for this product.' },
+    { name: 'deleteUnsentReports', reason: 'RN Firebase export for the native crashlytics module. The firebase-js-sdk does not ship a modular public API for this product.' },
+    { name: 'didCrashOnPreviousExecution', reason: 'RN Firebase export for the native crashlytics module. The firebase-js-sdk does not ship a modular public API for this product.' },
+    { name: 'crash', reason: 'RN Firebase export for the native crashlytics module. The firebase-js-sdk does not ship a modular public API for this product.' },
+    { name: 'log', reason: 'RN Firebase export for the native crashlytics module. The firebase-js-sdk does not ship a modular public API for this product.' },
+    { name: 'recordError', reason: 'RN Firebase export for the native crashlytics module. The firebase-js-sdk does not ship a modular public API for this product.' },
+    { name: 'sendUnsentReports', reason: 'RN Firebase export for the native crashlytics module. The firebase-js-sdk does not ship a modular public API for this product.' },
+    { name: 'setUserId', reason: 'RN Firebase export for the native crashlytics module. The firebase-js-sdk does not ship a modular public API for this product.' },
+    { name: 'setAttribute', reason: 'RN Firebase export for the native crashlytics module. The firebase-js-sdk does not ship a modular public API for this product.' },
+    { name: 'setAttributes', reason: 'RN Firebase export for the native crashlytics module. The firebase-js-sdk does not ship a modular public API for this product.' },
+    { name: 'setCrashlyticsCollectionEnabled', reason: 'RN Firebase export for the native crashlytics module. The firebase-js-sdk does not ship a modular public API for this product.' },
+    { name: 'SDK_VERSION', reason: 'RN Firebase package version string exported from the modular entry point. The firebase-js-sdk does not export SDK_VERSION from @firebase/crashlytics.' },
+    { name: 'Crashlytics', reason: 'RN Firebase export for the native crashlytics module. The firebase-js-sdk does not ship a modular public API for this product.' },
+    { name: 'Statics', reason: 'RN Firebase export for the native crashlytics module. The firebase-js-sdk does not ship a modular public API for this product.' },
+    { name: 'FirebaseApp', reason: 'RN Firebase export for the native crashlytics module. The firebase-js-sdk does not ship a modular public API for this product.' },
+  ],
+
+  differentShape: [
+  ],
+};
+
+export default config;

.github/scripts/compare-types/configs/empty-sdk.d.ts

@@ -0,0 +1,2 @@
+// Intentionally empty — RN-only Firebase products have no firebase-js-sdk modular API to compare.
+export {};

.github/scripts/compare-types/configs/firestore.ts

@@ -273,26 +273,25 @@ const config: PackageConfig = {
       name: 'deleteAllPersistentCacheIndexes',
       reason:
         'Returns `Promise<void>` in RN Firebase vs `void` in the firebase-js-sdk. ' +
-        'The RN implementation is async because it delegates to the native module.',
+        'Phase S hint: **keep-async: deferred persistent-cache IO** (web void schedules disk/index work; see PS-S2-gap).',
     },
     {
       name: 'disablePersistentCacheIndexAutoCreation',
       reason:
         'Returns `Promise<void>` in RN Firebase vs `void` in the firebase-js-sdk. ' +
-        'The RN implementation is async because it delegates to the native module.',
+        'Phase S hint: **keep-async: deferred persistent-cache IO** (see PS-S2-gap).',
     },
     {
       name: 'enablePersistentCacheIndexAutoCreation',
       reason:
         'Returns `Promise<void>` in RN Firebase vs `void` in the firebase-js-sdk. ' +
-        'The RN implementation is async because it delegates to the native module.',
+        'Phase S hint: **keep-async: deferred persistent-cache IO** (see PS-S2-gap).',
     },
     {
       name: 'initializeFirestore',
       reason:
-        'Returns `Promise<Firestore>` in RN Firebase vs `Firestore` in the ' +
-        'firebase-js-sdk. The RN implementation is async because it initialises ' +
-        'the native Firestore module.',
+        'Returns `Promise<Firestore>` in RN Firebase vs `Firestore` in the firebase-js-sdk. ' +
+        'Phase S hint: **Promise that could maybe sync-void+gate** (in-memory settings visible before return; see PS-S2-gap).',
     },
     {
       name: 'onSnapshotsInSync',

.github/scripts/compare-types/configs/functions.ts

@@ -0,0 +1,34 @@
+/**
+ * Known differences between the firebase-js-sdk public API and
+ * the @react-native-firebase/functions modular API.
+ *
+ * Each entry must have a `name` and a `reason`. Undocumented drift fails CI.
+ */
+
+import type { PackageConfig } from '../src/types';
+
+const config: PackageConfig = {
+  nameMapping: {
+    httpsCallableFromURL: 'httpsCallableFromUrl',
+  },
+
+  missingInRN: [
+    { name: 'FunctionsError', reason: 'RN Firebase surfaces callable failures through the `HttpsError` class instead of the firebase-js-sdk `FunctionsError` export.' },
+    { name: 'FunctionsErrorCodeCore', reason: 'Internal firebase-js-sdk error-code helper not re-exported by RN Firebase. Callable errors use `HttpsErrorCode` constants instead.' },
+  ],
+
+  extraInRN: [
+    { name: 'HttpsErrorCode', reason: 'RN Firebase exposes callable error code constants as a standalone export. The firebase-js-sdk surfaces these through the `FunctionsErrorCode` enum instead.' },
+    { name: 'SDK_VERSION', reason: 'RN Firebase package version string exported from the modular entry point. The firebase-js-sdk does not export SDK_VERSION from @firebase/functions.' },
+    { name: 'HttpsError', reason: 'RN Firebase re-exports the callable `HttpsError` class from its modular entry point for ergonomic imports.' },
+    { name: 'FunctionsStatics', reason: 'RN Firebase statics namespace type used by the legacy namespaced API surface. Not part of the firebase-js-sdk modular public API.' },
+    { name: 'FirebaseApp', reason: 'RN Firebase re-exports `FirebaseApp` from the modular entry point for convenience.' },
+  ],
+
+  differentShape: [
+    { name: 'Functions', reason: 'RN Firebase extends the Functions service interface with native region/custom-domain helpers and uses async callable factories.' },
+    { name: 'FunctionsErrorCode', reason: 'RN Firebase `FunctionsErrorCode` enum includes additional native bridge error codes beyond the firebase-js-sdk set.' },
+  ],
+};
+
+export default config;

.github/scripts/compare-types/configs/in-app-messaging.ts

@@ -0,0 +1,31 @@
+/**
+ * Known differences between the firebase-js-sdk public API and
+ * the @react-native-firebase/in-app-messaging modular API.
+ *
+ * Each entry must have a `name` and a `reason`. Undocumented drift fails CI.
+ */
+
+import type { PackageConfig } from '../src/types';
+
+const config: PackageConfig = {
+  nameMapping: {},
+
+  missingInRN: [
+  ],
+
+  extraInRN: [
+    { name: 'getInAppMessaging', reason: 'RN Firebase export for the native in-app-messaging module. The firebase-js-sdk does not ship a modular public API for this product.' },
+    { name: 'isMessagesDisplaySuppressed', reason: 'RN Firebase export for the native in-app-messaging module. The firebase-js-sdk does not ship a modular public API for this product.' },
+    { name: 'setMessagesDisplaySuppressed', reason: 'RN Firebase export for the native in-app-messaging module. The firebase-js-sdk does not ship a modular public API for this product.' },
+    { name: 'isAutomaticDataCollectionEnabled', reason: 'RN Firebase export for the native in-app-messaging module. The firebase-js-sdk does not ship a modular public API for this product.' },
+    { name: 'setAutomaticDataCollectionEnabled', reason: 'RN Firebase export for the native in-app-messaging module. The firebase-js-sdk does not ship a modular public API for this product.' },
+    { name: 'triggerEvent', reason: 'RN Firebase export for the native in-app-messaging module. The firebase-js-sdk does not ship a modular public API for this product.' },
+    { name: 'SDK_VERSION', reason: 'RN Firebase package version string exported from the modular entry point. The firebase-js-sdk does not export SDK_VERSION from @firebase/in-app-messaging.' },
+    { name: 'InAppMessaging', reason: 'RN Firebase export for the native in-app-messaging module. The firebase-js-sdk does not ship a modular public API for this product.' },
+  ],
+
+  differentShape: [
+  ],
+};
+
+export default config;