Skip to content

Commit 46cf354

Browse files
mikehardymikehardy
committed
docs: document all API gaps / platform divergence / migration items
1 parent f3a0785 commit 46cf354

35 files changed

Lines changed: 425 additions & 43 deletions

File tree

‎.spellcheck.dict.txt‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -235,6 +235,9 @@ TOTP
235235
triaging
236236
TurboModule
237237
TurboModules
238+
Codegen
239+
IndexedDB
240+
pre-v26
238241
typings
239242
TypeDoc
240243
UI

‎docs/ai/usage/index.mdx‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,13 @@ yarn add @react-native-firebase/app
1818
yarn add @react-native-firebase/ai
1919
```
2020

21+
# Platform support
22+
23+
| | |
24+
| -------------------- | ---------------------------------------------------------------------- |
25+
| **Platforms** | Android, iOS, Web (firebase-js-sdk interop) |
26+
| **New Architecture** | **Not required** — pure JavaScript package with no native TurboModule. |
27+
2128
# What does it do
2229

2330
Firebase AI Logic gives you access to the latest generative AI models from Google.

‎docs/analytics/usage/index.mdx‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,15 @@ cd ios/ && pod install
2424
If you're using an older version of React Native without autolinking support, or wish to integrate into an existing project,
2525
you can follow the manual installation steps for [iOS](/analytics/usage/installation/ios) and [Android](/analytics/usage/installation/android).
2626

27+
# Platform support and New Architecture
28+
29+
| | |
30+
| -------------------- | ---------------------------------------------------------------------------------------------- |
31+
| **Platforms** | Android, iOS (native Firebase SDK) |
32+
| **New Architecture** | **Required** from v26. See [Migrating to v26](/migrating-to-v26#new-architecture-requirement). |
33+
34+
**Platform notes:** On-device conversion measurement helpers (`initiateOnDeviceConversionMeasurement*`) are **iOS only**; on Android and web the JS layer resolves without calling native (no-op). `logTransaction` (verified iOS in-app purchase events) is **iOS only** and **rejects** on other platforms. Analytics supports only the default Firebase app.
35+
2736
# What does it do
2837

2938
Analytics collects usage and behavior data for your app. Its two primary concerns are:

‎docs/app-check/usage/index.mdx‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,15 @@ You may find excluding the `i386` architecture via an addition to the `ios/Podfi
3939
end
4040
```
4141

42+
# Platform support and New Architecture
43+
44+
| | |
45+
| -------------------- | ---------------------------------------------------------------------------------------------- |
46+
| **Platforms** | Android, iOS (native Firebase SDK) |
47+
| **New Architecture** | **Required** from v26. See [Migrating to v26](/migrating-to-v26#new-architecture-requirement). |
48+
49+
**Platform notes:** Use `ReactNativeFirebaseAppCheckProvider` for native attestation (Device Check, App Attest, Play Integrity). firebase-js-sdk `ReCaptchaEnterpriseProvider` and `ReCaptchaV3Provider` are **web only**.
50+
4251
# What does it do
4352

4453
App Check works alongside other Firebase services to help protect your backend resources from abuse, such as billing fraud or phishing. With App Check, devices running your app will use an app or device attestation provider that attests to one or both of the following:

‎docs/app-distribution/usage/index.mdx‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,15 @@ apply plugin: 'com.android.application'
4444
apply plugin: 'com.google.firebase.appdistribution'
4545
```
4646

47+
# Platform support and New Architecture
48+
49+
| | |
50+
| -------------------- | ---------------------------------------------------------------------------------------------- |
51+
| **Platforms** | Android, iOS (native Firebase SDK) |
52+
| **New Architecture** | **Required** from v26. See [Migrating to v26](/migrating-to-v26#new-architecture-requirement). |
53+
54+
> **React Native only:** There is no firebase-js-sdk web equivalent for App Distribution.
55+
4756
# What does it do
4857

4958
Firebase App Distribution gives a holistic view of your beta testing program across iOS and Android, providing you with valuable feedback before a new release is in production. You can send pre-release versions of your app using the console or your CI servers, and installing your app is easy for testers.

‎docs/app/usage.mdx‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,15 @@ The App module is available by default once you have installed the React Native
1111
- Creating [Secondary Firebase App Instances](/app/usage#secondary-apps).
1212
- Exposing [Utilities](/app/utils) to aid development.
1313

14+
# Platform support and New Architecture
15+
16+
| | |
17+
| -------------------- | ---------------------------------------------------------------------------------------------- |
18+
| **Platforms** | Android, iOS (native Firebase SDK) |
19+
| **New Architecture** | **Required** from v26. See [Migrating to v26](/migrating-to-v26#new-architecture-requirement). |
20+
21+
**Platform notes:** `initializeApp` is async on React Native (native bridge). `registerVersion` is **web only** and throws on native platforms.
22+
1423
# Secondary Apps
1524

1625
Unlike the Firebase Web SDK, there is no need to manually call the [`initializeApp`](https://firebase.google.com/docs/web/setup#add-sdks-initialize)

‎docs/auth/usage/index.mdx‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,15 @@ cd ios/ && pod install
2424
If you're using an older version of React Native without autolinking support, or wish to integrate into an existing project,
2525
you can follow the manual installation steps for [iOS](/auth/usage/installation/ios) and [Android](/auth/usage/installation/android).
2626

27+
# Platform support and New Architecture
28+
29+
| | |
30+
| -------------------- | ---------------------------------------------------------------------------------------------- |
31+
| **Platforms** | Android, iOS (native Firebase SDK) |
32+
| **New Architecture** | **Required** from v26. See [Migrating to v26](/migrating-to-v26#new-architecture-requirement). |
33+
34+
**Platform notes:** Several firebase-js-sdk web helpers throw on React Native (`setPersistence`, `getRedirectResult`, `revokeAccessToken`, `useDeviceLanguage`, `linkWithPhoneNumber`, `reauthenticateWithPhoneNumber`). `useUserAccessGroup` is **iOS only**. See [Migrating to v26 — Platform behavior differences](/migrating-to-v26#platform-behavior-differences).
35+
2736
# What does it do
2837

2938
Firebase Authentication provides backend services & easy-to-use SDKs to authenticate users to your app. It supports

‎docs/crashlytics/usage/index.mdx‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,15 @@ you can follow the manual installation steps for [iOS](/crashlytics/usage/instal
3232

3333
> You may like reading a short article we wrote that explains how to configure and _most importantly_ verify your crashlytics installation so you are sure it is working. https://invertase.io/blog/react-native-firebase-crashlytics-configuration
3434
35+
# Platform support and New Architecture
36+
37+
| | |
38+
| -------------------- | ---------------------------------------------------------------------------------------------- |
39+
| **Platforms** | Android, iOS (native Firebase SDK) |
40+
| **New Architecture** | **Required** from v26. See [Migrating to v26](/migrating-to-v26#new-architecture-requirement). |
41+
42+
> **React Native only:** There is no firebase-js-sdk web equivalent for Crashlytics.
43+
3544
# What does it do
3645

3746
Crashlytics helps you to collect analytics and details about crashes and errors that occur in your app. It does this through three aspects:

‎docs/database/usage/index.mdx‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,15 @@ cd ios/ && pod install && cd ..
2424
If you're using an older version of React Native without autolinking support, or wish to integrate into an existing project,
2525
you can follow the manual installation steps for [iOS](/database/usage/installation/ios) and [Android](/database/usage/installation/android).
2626

27+
# Platform support and New Architecture
28+
29+
| | |
30+
| -------------------- | ---------------------------------------------------------------------------------------------- |
31+
| **Platforms** | Android, iOS (native Firebase SDK) |
32+
| **New Architecture** | **Required** from v26. See [Migrating to v26](/migrating-to-v26#new-architecture-requirement). |
33+
34+
**Platform notes:** `getServerTime`, `setPersistenceEnabled`, and `setPersistenceCacheSizeBytes` are RN-specific. `goOnline` / `goOffline` cross the async native bridge. `forceLongPolling` / `forceWebSockets` throw — transport is native-controlled.
35+
2736
# What does it do
2837

2938
The Realtime Database is a cloud-hosted database. Data is stored as JSON and synchronized in realtime to every connected

‎docs/firestore/usage/index.mdx‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,15 @@ you can follow the manual installation steps for [iOS](/firestore/usage/installa
2727
If you have started to receive a `app:mergeDexDebug` error after adding Cloud Firestore, please read the
2828
[Enabling Multidex](/enabling-multidex) documentation for more information on how to resolve this error.
2929

30+
# Platform support and New Architecture
31+
32+
| | |
33+
| -------------------- | ---------------------------------------------------------------------------------------------- |
34+
| **Platforms** | Android, iOS (native Firebase SDK); macOS via firebase-js-sdk web interop |
35+
| **New Architecture** | **Required** from v26. See [Migrating to v26](/migrating-to-v26#new-architecture-requirement). |
36+
37+
**Platform notes:** IndexedDB persistence and `memoryLocalCache` / `persistentLocalCache` are **web only**. Native persistence is controlled by the iOS/Android Firestore SDK. `initializeFirestore` is async on React Native.
38+
3039
# What does it do
3140

3241
Firestore is a flexible, scalable NoSQL cloud database to store and sync data. It keeps your data in sync across client

0 commit comments

Comments
 (0)