@react-native-firebase/app 20.2.1 → 20.4.0

package/CHANGELOG.md

@@ -3,6 +3,18 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [20.4.0](https://github.com/invertase/react-native-firebase/compare/v20.3.0...v20.4.0) (2024-08-13)
+
+### Features
+
+- **firestore:** support for second database ([#7949](https://github.com/invertase/react-native-firebase/issues/7949)) ([eec08a0](https://github.com/invertase/react-native-firebase/commit/eec08a06f41dd96d13778fbed2afcaaac238fca4))
+
+## [20.3.0](https://github.com/invertase/react-native-firebase/compare/v20.2.1...v20.3.0) (2024-07-19)
+
+### Bug Fixes
+
+- **other:** add api for persistence via Async Storage ([030eea9](https://github.com/invertase/react-native-firebase/commit/030eea91f297a4014ab86cfb141ae938f200c5e5))
+
 ## [20.2.1](https://github.com/invertase/react-native-firebase/compare/v20.2.0...v20.2.1) (2024-07-17)
 
 **Note:** Version bump only for package @react-native-firebase/app

package/__tests__/app.test.ts

@@ -0,0 +1,43 @@
+import { describe, expect, it } from '@jest/globals';
+
+import {
+  deleteApp,
+  registerVersion,
+  onLog,
+  getApps,
+  initializeApp,
+  getApp,
+  setLogLevel,
+} from '../lib';
+
+describe('App', function () {
+  describe('modular', function () {
+    it('`deleteApp` function is properly exposed to end user', function () {
+      expect(deleteApp).toBeDefined();
+    });
+
+    it('`registerVersion` function is properly exposed to end user', function () {
+      expect(registerVersion).toBeDefined();
+    });
+
+    it('`onLog` function is properly exposed to end user', function () {
+      expect(onLog).toBeDefined();
+    });
+
+    it('`getApps` function is properly exposed to end user', function () {
+      expect(getApps).toBeDefined();
+    });
+
+    it('`initializeApp` function is properly exposed to end user', function () {
+      expect(initializeApp).toBeDefined();
+    });
+
+    it('`getApp` function is properly exposed to end user', function () {
+      expect(getApp).toBeDefined();
+    });
+
+    it('`setLogLevel` function is properly exposed to end user', function () {
+      expect(setLogLevel).toBeDefined();
+    });
+  });
+});

package/android/src/reactnative/java/io/invertase/firebase/app/ReactNativeFirebaseVersion.java

@@ -18,5 +18,5 @@ package io.invertase.firebase.app;
  */
 // generated file - do not modify or commit
 public class ReactNativeFirebaseVersion {
-  public static String VERSION = "20.2.1";
+  public static String VERSION = "20.4.0";
 }

package/ios/RNFBApp/RNFBVersion.m

@@ -18,4 +18,4 @@
 #import <React/RCTVersion.h>
 
 // generated file - do not modify or commit
-NSString* const RNFBVersionString = @"20.2.1";
+NSString* const RNFBVersionString = @"20.4.0";

package/lib/index.d.ts

@@ -158,6 +158,36 @@ export namespace ReactNativeFirebase {
     utils(): Utils.Module;
   }
 
+  /**
+   * Interface for a supplied `AsyncStorage`.
+   */
+  export interface ReactNativeAsyncStorage {
+    /**
+     * Persist an item in storage.
+     *
+     * @param key - storage key.
+     * @param value - storage value.
+     */
+    // eslint-disable-next-line @typescript-eslint/ban-types
+    setItem: Function;
+    /**
+     * Retrieve an item from storage.
+     *
+     * @param key - storage key.
+     */
+    // eslint-disable-next-line @typescript-eslint/ban-types
+    getItem: Function;
+    /**
+     * Remove an item from storage.
+     *
+     * @param key - storage key.
+     */
+    // eslint-disable-next-line @typescript-eslint/ban-types
+    removeItem: Function;
+
+    [key: string]: any;
+  }
+
   export interface Module {
     /**
      * Create (and initialize) a FirebaseApp.
@@ -201,6 +231,14 @@ export namespace ReactNativeFirebase {
      */
     setLogLevel(logLevel: LogLevelString): void;
 
+    /**
+     * The `AsyncStorage` implementation to use for persisting data on 'Other' platforms.
+     * If not specified, in memory persistence is used.
+     *
+     * This is required if you want to persist things like Auth sessions, Analytics device IDs, etc.
+     */
+    setReactNativeAsyncStorage(asyncStorage: ReactNativeAsyncStorage): void;
+
     /**
      * A (read-only) array of all the initialized Apps.
      */
@@ -573,5 +611,7 @@ export namespace Utils {
  */
 export const utils: ReactNativeFirebase.FirebaseModuleWithStatics<Utils.Module, Utils.Statics>;
 
+export * from './modular';
+
 declare const module: ReactNativeFirebase.Module;
 export default module;

package/lib/index.js

@@ -18,7 +18,7 @@
 import { getFirebaseRoot } from './internal/registry/namespace';
 
 export const firebase = getFirebaseRoot();
-export * from './modular/app';
+export * from './modular';
 export { default as utils } from './utils';
 
 export default firebase;

package/lib/internal/asyncStorage.js

@@ -0,0 +1,47 @@
+export const memoryStorage = new Map();
+
+export const prefix = '@react-native-firebase:';
+
+const asyncStorageMemory = {
+  setItem(key, value) {
+    memoryStorage.set(key, value);
+    return Promise.resolve();
+  },
+  getItem(key) {
+    const hasValue = memoryStorage.has(key);
+    if (hasValue) {
+      return Promise.resolve(memoryStorage.get(key));
+    }
+    return Promise.resolve(null);
+  },
+  removeItem: function (key) {
+    memoryStorage.delete(key);
+    return Promise.resolve();
+  },
+};
+
+let asyncStorage = asyncStorageMemory;
+
+export async function getReactNativeAsyncStorageInternal() {
+  return asyncStorage;
+}
+
+export function setReactNativeAsyncStorageInternal(asyncStorageInstance) {
+  asyncStorage = asyncStorageInstance || asyncStorageMemory;
+}
+
+export function isMemoryStorage() {
+  return asyncStorage === asyncStorageMemory;
+}
+
+export async function setItem(key, value) {
+  return await asyncStorage.setItem(prefix + key, value);
+}
+
+export async function getItem(key) {
+  return await asyncStorage.getItem(prefix + key);
+}
+
+export async function removeItem(key) {
+  return await asyncStorage.removeItem(prefix + key);
+}

package/lib/internal/registry/app.js

@@ -20,11 +20,13 @@ import {
   isOther,
   isNull,
   isObject,
+  isFunction,
   isString,
   isUndefined,
 } from '@react-native-firebase/app/lib/common';
 import FirebaseApp from '../../FirebaseApp';
 import { DEFAULT_APP_NAME } from '../constants';
+import { setReactNativeAsyncStorageInternal } from '../asyncStorage';
 import { getAppModule } from './nativeModule';
 
 const APP_REGISTRY = {};
@@ -172,7 +174,7 @@ export function initializeApp(options = {}, configOrName) {
     );
   }
 
-  const app = new FirebaseApp(options, { name }, false, deleteApp.bind(null, name, true));
+  const app = new FirebaseApp(options, appConfig, false, deleteApp.bind(null, name, true));
 
   // Note these initialization actions with side effects are performed prior to knowledge of
   // successful initialization in the native code. Native code *may* throw an error.
@@ -180,7 +182,7 @@ export function initializeApp(options = {}, configOrName) {
   onAppCreateFn(APP_REGISTRY[name]);
 
   return getAppModule()
-    .initializeApp(options, { name })
+    .initializeApp(options, appConfig)
     .then(() => {
       app._initialized = true;
       return app;
@@ -207,6 +209,32 @@ export function setLogLevel(logLevel) {
   }
 }
 
+export function setReactNativeAsyncStorage(asyncStorage) {
+  if (!isObject(asyncStorage)) {
+    throw new Error("firebase.setReactNativeAsyncStorage(*) 'asyncStorage' must be an object.");
+  }
+
+  if (!isFunction(asyncStorage.setItem)) {
+    throw new Error(
+      "firebase.setReactNativeAsyncStorage(*) 'asyncStorage.setItem' must be a function.",
+    );
+  }
+
+  if (!isFunction(asyncStorage.getItem)) {
+    throw new Error(
+      "firebase.setReactNativeAsyncStorage(*) 'asyncStorage.getItem' must be a function.",
+    );
+  }
+
+  if (!isFunction(asyncStorage.removeItem)) {
+    throw new Error(
+      "firebase.setReactNativeAsyncStorage(*) 'asyncStorage.removeItem' must be a function.",
+    );
+  }
+
+  setReactNativeAsyncStorageInternal(asyncStorage);
+}
+
 /**
  *
  */

package/lib/internal/registry/namespace.js

@@ -15,7 +15,7 @@
  *
  */
 
-import { isString } from '@react-native-firebase/app/lib/common';
+import { isString } from '../../common';
 import FirebaseApp from '../../FirebaseApp';
 import SDK_VERSION from '../../version';
 import { DEFAULT_APP_NAME, KNOWN_NAMESPACES } from '../constants';
@@ -25,6 +25,7 @@ import {
   getApps,
   initializeApp,
   setLogLevel,
+  setReactNativeAsyncStorage,
   setOnAppCreate,
   setOnAppDestroy,
 } from './app';
@@ -92,19 +93,21 @@ function getOrCreateModuleForApp(app, moduleNamespace) {
     );
   }
 
-  // e.g. firebase.storage(customUrlOrRegion)
-  function firebaseModuleWithArgs(customUrlOrRegion) {
-    if (customUrlOrRegion !== undefined) {
+  // e.g. firebase.storage(customUrlOrRegion), firebase.functions(customUrlOrRegion), firebase.firestore(databaseId), firebase.database(url)
+  function firebaseModuleWithArgs(customUrlOrRegionOrDatabaseId) {
+    if (customUrlOrRegionOrDatabaseId !== undefined) {
       if (!hasCustomUrlOrRegionSupport) {
         // TODO throw Module does not support arguments error
       }
 
-      if (!isString(customUrlOrRegion)) {
+      if (!isString(customUrlOrRegionOrDatabaseId)) {
         // TODO throw Module first argument must be a string error
       }
     }
 
-    const key = customUrlOrRegion ? `${customUrlOrRegion}:${moduleNamespace}` : moduleNamespace;
+    const key = customUrlOrRegionOrDatabaseId
+      ? `${customUrlOrRegionOrDatabaseId}:${moduleNamespace}`
+      : moduleNamespace;
 
     if (!APP_MODULE_INSTANCE[app.name]) {
       APP_MODULE_INSTANCE[app.name] = {};
@@ -114,7 +117,7 @@ function getOrCreateModuleForApp(app, moduleNamespace) {
       APP_MODULE_INSTANCE[app.name][key] = new ModuleClass(
         app,
         NAMESPACE_REGISTRY[moduleNamespace],
-        customUrlOrRegion,
+        customUrlOrRegionOrDatabaseId,
       );
     }
 
@@ -241,6 +244,7 @@ export function firebaseAppModuleProxy(app, moduleNamespace) {
 export function createFirebaseRoot() {
   FIREBASE_ROOT = {
     initializeApp,
+    setReactNativeAsyncStorage,
     get app() {
       return getApp;
     },

package/lib/internal/registry/nativeModule.js

@@ -153,7 +153,10 @@ function initialiseNativeModule(module) {
 function subscribeToNativeModuleEvent(eventName) {
   if (!NATIVE_MODULE_EVENT_SUBSCRIPTIONS[eventName]) {
     RNFBNativeEventEmitter.addListener(eventName, event => {
-      if (event.appName) {
+      if (event.appName && event.databaseId) {
+        // Firestore requires both appName and databaseId to prefix
+        SharedEventEmitter.emit(`${event.appName}-${event.databaseId}-${eventName}`, event);
+      } else if (event.appName) {
         // native event has an appName property - auto prefix and internally emit
         SharedEventEmitter.emit(`${event.appName}-${eventName}`, event);
       } else {

package/lib/modular/index.d.ts

@@ -0,0 +1,62 @@
+import { ReactNativeFirebase } from '..';
+
+import FirebaseApp = ReactNativeFirebase.FirebaseApp;
+import FirebaseAppOptions = ReactNativeFirebase.FirebaseAppOptions;
+import LogLevelString = ReactNativeFirebase.LogLevelString;
+
+/**
+ * Renders this app unusable and frees the resources of all associated services.
+ * @param app - FirebaseApp - The app to delete.
+ * @returns Promise<void>
+ */
+export function deleteApp(app: FirebaseApp): Promise<void>;
+
+/**
+ * Registers a library's name and version for platform logging purposes.
+ * @param libraryKeyOrName - Library name or key.
+ * @param version - Library version.
+ * @param variant - Library variant.
+ * @returns Promise<void>
+ */
+export function registerVersion(
+  libraryKeyOrName: string,
+  version: string,
+  variant: string | null,
+): Promise<void>;
+
+/**
+ * Sets log handler for all Firebase SDKs.
+ * @param logCallback - The callback function to handle logs.
+ * @param options - Optional settings for log handling.
+ * @returns Promise<void>
+ * @throws Error - onLog is only supported on Web
+ */
+export function onLog(logCallback: (logData: any) => void, options?: any): Promise<void>;
+
+/**
+ * Gets the list of all initialized apps.
+ * @returns FirebaseApp[] - An array of all initialized Firebase apps.
+ */
+export function getApps(): FirebaseApp[];
+
+/**
+ * Initializes a Firebase app with the provided options and name.
+ * @param options - Options to configure the services used in the app.
+ * @param name - The optional name of the app to initialize ('[DEFAULT]' if omitted).
+ * @returns FirebaseApp - The initialized Firebase app.
+ */
+export function initializeApp(options: FirebaseAppOptions, name?: string): FirebaseApp;
+
+/**
+ * Retrieves an instance of a Firebase app.
+ * @param name - The optional name of the app to return ('[DEFAULT]' if omitted).
+ * @returns FirebaseApp - The requested Firebase app instance.
+ */
+export function getApp(name?: string): FirebaseApp;
+
+/**
+ * Sets the log level across all Firebase SDKs.
+ * @param logLevel - The log level to set ('debug', 'verbose', 'info', 'warn', 'error', 'silent').
+ * @returns void
+ */
+export function setLogLevel(logLevel: LogLevelString): void;

package/lib/modular/index.js

@@ -0,0 +1,80 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+import {
+  deleteApp as deleteAppCompat,
+  getApp as getAppCompat,
+  getApps as getAppsCompat,
+  initializeApp as initializeAppCompat,
+  setLogLevel as setLogLevelCompat,
+} from '../internal';
+
+/**
+ * @typedef {import('..').ReactNativeFirebase.FirebaseApp} FirebaseApp
+ * @typedef {import('..').ReactNativeFirebase.FirebaseAppOptions} FirebaseAppOptions
+ * @typedef {import('..').ReactNativeFirebase.LogLevelString} LogLevelString
+ */
+
+/**
+ * Renders this app unusable and frees the resources of all associated services.
+ * @param {FirebaseApp} app - The app to delete.
+ * @returns {Promise<void>}
+ */
+export function deleteApp(app) {
+  return deleteAppCompat(app.name, app._nativeInitialized);
+}
+
+/**
+ * Registers a library's name and version for platform logging purposes.
+  @param {string} libraryKeyOrName - library name or key.
+  @param {string} version - library version.
+  @param {string | null} variant - library variant.
+ * @returns {Promise<void>}
+ */
+export function registerVersion(libraryKeyOrName, version, variant) {
+  throw new Error('registerVersion is only supported on Web');
+}
+
+/**
+ * Sets log handler for all Firebase SDKs.
+ * @param {Function} logCallback - The callback function to handle logs.
+ * @param {Object} [options] - Optional settings for log handling.
+ * @returns {Promise<void>}
+ */
+export function onLog(logCallback, options) {
+  throw new Error('onLog is only supported on Web');
+}
+
+/**
+ * Gets the list of all initialized apps.
+ * @returns {FirebaseApp[]} - An array of all initialized Firebase apps.
+ */
+export function getApps() {
+  return getAppsCompat();
+}
+
+/**
+ * Initializes a Firebase app with the provided options and name.
+ * @param {FirebaseAppOptions} options - Options to configure the services used in the app.
+ * @param {string} [name] - The optional name of the app to initialize ('[DEFAULT]' if omitted).
+ * @returns {FirebaseApp} - The initialized Firebase app.
+ */
+export function initializeApp(options, name) {
+  return initializeAppCompat(options, name);
+}
+
+/**
+ * Retrieves an instance of a Firebase app.
+ * @param {string} [name] - The optional name of the app to return ('[DEFAULT]' if omitted).
+ * @returns {FirebaseApp} - The requested Firebase app instance.
+ */
+export function getApp(name) {
+  return getAppCompat(name);
+}
+
+/**
+ * Sets the log level across all Firebase SDKs.
+ * @param {LogLevelString} logLevel - The log level to set ('debug', 'verbose', 'info', 'warn', 'error', 'silent').
+ * @returns {void}
+ */
+export function setLogLevel(logLevel) {
+  return setLogLevelCompat(logLevel);
+}

package/lib/version.js

@@ -1,2 +1,2 @@
 // Generated by genversion.
-module.exports = '20.2.1';
+module.exports = '20.4.0';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-native-firebase/app",
-  "version": "20.2.1",
+  "version": "20.4.0",
   "author": "Invertase <oss@invertase.io> (http://invertase.io)",
   "description": "A well tested, feature rich Firebase implementation for React Native, supporting iOS & Android. Individual module support for Admob, Analytics, Auth, Crash Reporting, Cloud Firestore, Database, Dynamic Links, Functions, Messaging (FCM), Remote Config, Storage and more.",
   "main": "lib/index.js",
@@ -58,10 +58,10 @@
   },
   "dependencies": {
     "firebase": "10.12.2",
-    "opencollective-postinstall": "^2.0.3",
     "superstruct": "^0.6.2"
   },
   "devDependencies": {
+    "@react-native-async-storage/async-storage": "^1.24.0",
     "expo": "^50.0.19"
   },
   "peerDependenciesMeta": {
@@ -89,5 +89,5 @@
       "playServicesAuth": "21.2.0"
     }
   },
-  "gitHead": "2c787c2dbefbefcc637018e1e5d74a73b39600ab"
+  "gitHead": "3ac3e9623674a8db52c111b4aa0a85a883260116"
 }

package/lib/modular/app.js

@@ -1,33 +0,0 @@
-/* eslint-disable @typescript-eslint/no-unused-vars */
-import {
-  deleteApp as deleteAppCompat,
-  getApp,
-  getApps,
-  initializeApp,
-  setLogLevel,
-} from '../internal';
-
-/**
- * Renders this app unusable and frees the resources of all associated services.
- * @param app - FirebaseApp - The app to delete.
- * @returns
- */
-export function deleteApp(app) {
-  return deleteAppCompat(app.name, app._nativeInitialized);
-}
-
-/**
- * Registers a library's name and version for platform logging purposes.
- */
-export function registerVersion() {
-  throw new Error('registerVersion is only supported on Web');
-}
-
-/**
- * Sets log handler for all Firebase SDKs.
- */
-export function onLog(logCallback, options) {
-  throw new Error('onLog is only supported on Web');
-}
-
-export { getApps, initializeApp, getApp, setLogLevel };