docs: deprecation guide for moving to firebase-js-sdk v9 modular API

.spellcheck.dict.txt

@@ -119,6 +119,7 @@ mono-repo
 multidex
 Multidex
 namespace
+Namespaced
 namespaced
 natively
 NDK
@@ -133,6 +134,7 @@ OAuth
 onboarding
 onwards
 OpenID
+Perf
 perf
 performant
 personalization
@@ -163,6 +165,7 @@ RN60
 RN61
 RNFB
 RNFirebase
+RTDB
 SafetyNet
 Salakar
 scalable
@@ -213,6 +216,7 @@ v5
 v6
 v7
 v9
+v22
 Ventura
 VPN
 VSCode

docs/index.md

@@ -1,9 +1,11 @@
 ---
 title: React Native Firebase
 description: Welcome to React Native Firebase! To get started, you must first setup a Firebase project and install the "app" module.
-next: /typescript
+next: /migrating-to-v22
 ---
 
+> React Native Firebase has begun to deprecate the namespaced API (i.e firebase-js-sdk `< v9` chaining API). React Native Firebase will be moving to the modular API (i.e. firebase-js-sdk `>= v9`) in the next major release. See [migration guide](/migrating-to-v22) for more information.
+
 React Native Firebase is the officially recommended collection of packages that brings React Native support for all Firebase services on both Android and iOS apps.
 
 React Native Firebase fully supports React Native apps built using [React Native CLI](https://reactnative.dev/docs/environment-setup?guide=native) or using [Expo](https://docs.expo.dev/).

docs/migrating-to-v22.md

@@ -0,0 +1,74 @@
+---
+title: Migrating to v22
+description: Migrate to React Native Firebase v22.
+previous: /
+next: /typescript
+---
+
+# Switching off warning logs
+
+You may notice an influx of console warning logs as we continue deprecating all existing namespaced API. If you would like to switch these logs off, you may set the following global property to `true` anywhere before you initialize Firebase.
+
+```js
+globalThis.RNFB_SILENCE_V8_DEPRECATION_WARNINGS = true;
+```
+
+# Migrating to React Native modular API
+
+React Native Firebase does not currently have documentation for modular API. A refresh of the React Native Firebase documentation is something we will be aiming to achieve in the near future. We're keen to move the project to TypeScript which will then allow us to generate reference documentation from those types.
+
+However, if you are familiar with the Firebase JS SDK, it will be a much smoother process. React Native Firebase is using the same API as can be found on the official [Firebase JS SDK modular API documentation](https://firebase.google.com/docs/reference/js).
+
+## Firestore Deprecation Example
+
+### Namespaced (deprecated) Query
+
+You ought to move away from the following way of making Firestore queries. The React Native Firebase namespaced API is being completely removed in React Native Firebase v22:
+
+```js
+import firestore from '@react-native-firebase/firestore';
+
+const db = firestore();
+
+const querySnapshot = await db.collection('cities').where('capital', '==', true).get();
+
+querySnapshot.forEach(doc => {
+  console.log(doc.id, ' => ', doc.data());
+});
+```
+
+### Modular Query
+
+This is how the same query would look using the new, React Native Firebase modular API:
+
+```js
+import { collection, query, where, getDocs, getFirestore } from '@react-native-firebase/firestore';
+
+const db = getFirestore();
+
+const q = query(collection(db, 'cities'), where('capital', '==', true));
+
+const querySnapshot = await getDocs(q);
+
+querySnapshot.forEach(doc => {
+  console.log(doc.id, ' => ', doc.data());
+});
+```
+
+For more examples of requesting Firestore data, see the official Firebase documentation for [Get data with Cloud Firestore](https://firebase.google.com/docs/firestore/query-data/get-data).
+
+### Migration Help
+
+You will find code snippets for "Web namespaced API" and "Web modular API" throughout the official Firebase documentation. Update your code to use "Web modular API". Here are some links to help you get started:
+
+- [Firestore](https://firebase.google.com/docs/firestore/quickstart)
+- [Auth](https://firebase.google.com/docs/auth/web/start)
+- [RTDB](https://firebase.google.com/docs/database/web/start)
+- [Storage](https://firebase.google.com/docs/storage/web/start)
+- [Remote Config](https://firebase.google.com/docs/remote-config/get-started?platform=web)
+- [Messaging](https://firebase.google.com/docs/cloud-messaging/js/client)
+- [Functions](https://firebase.google.com/docs/functions/callable)
+- [App Check](https://firebase.google.com/docs/app-check/web/recaptcha-provider)
+- [Analytics](https://firebase.google.com/docs/analytics/get-started)
+- [Perf](https://firebase.google.com/docs/perf-mon/get-started-web)
+- [Crashlytics](https://github.com/invertase/react-native-firebase/blob/main/packages/crashlytics/lib/modular/index.d.ts) (Crashlytics doesn't exist on Firebase web, this is a link to the type declarations which contains all methods available).

docs/sidebar.yaml

@@ -1,6 +1,8 @@
 ---
 - - Getting Started
   - '/'
+- - Migration Guide to v22
+  - '/migrating-to-v22'
 - - TypeScript
   - '/typescript'
 - - Platforms

docs/typescript.md

@@ -2,7 +2,7 @@
 title: TypeScript
 description: Using TypeScript with React Native Firebase
 next: /other-platforms
-previous:
+previous: /migrating-to-v22
 ---
 
 The React Native Firebase project comes with support for TypeScript. The project provides

packages/app/lib/common/index.js

@@ -214,8 +214,8 @@ const mapOfDeprecationReplacements = {
 };
 
 const v8deprecationMessage =
-  'This v8 method is deprecated and will be removed in the next major release ' +
-  'as part of move to match Firebase Web modular v9 SDK API.';
+  'This method is deprecated (as well as all React Native Firebase namespaced API) and will be removed in the next major release ' +
+  'as part of move to match Firebase Web modular v9 SDK API. Please see migration guide for more details: https://rnfirebase.io/migrating-to-v22';
 
 export function deprecationConsoleWarning(nameSpace, methodName, instanceName, isModularMethod) {
   if (!isModularMethod) {
@@ -225,8 +225,11 @@ export function deprecationConsoleWarning(nameSpace, methodName, instanceName, i
       const deprecatedMethod = instanceMap[methodName];
       if (instanceMap && deprecatedMethod) {
         const message = createMessage(nameSpace, methodName, instanceName);
-        // eslint-disable-next-line no-console
-        console.warn(message);
+
+        if (!globalThis.RNFB_SILENCE_V8_DEPRECATION_WARNINGS) {
+          // eslint-disable-next-line no-console
+          console.warn(message);
+        }
       }
     }
   }
@@ -367,6 +370,8 @@ export function warnIfNotModularCall(args, replacementMethodName = '') {
     message += ` Please use \`${replacementMethodName}\` instead.`;
   }
 
-  // eslint-disable-next-line no-console
-  console.warn(message);
+  if (!globalThis.RNFB_SILENCE_V8_DEPRECATION_WARNINGS) {
+    // eslint-disable-next-line no-console
+    console.warn(message);
+  }
 }