@react-native-firebase/app 23.6.0 → 23.8.0

package/lib/internal/web/RNFBAppModule.ts

@@ -0,0 +1,318 @@
+/*
+ * Copyright (c) 2016-present Invertase Limited & Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this library except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+import { initializeApp, setLogLevel, getApp, getApps, deleteApp } from './firebaseApp';
+import { DeviceEventEmitter } from 'react-native';
+import { type ReactNativeFirebase } from '../../index';
+
+// Types for internal state
+interface QueuedEvent {
+  eventName: string;
+  eventBody: any;
+}
+
+interface EventListeners {
+  [eventName: string]: number;
+}
+
+interface ListenersMap {
+  listeners: number;
+  queued: number;
+  events: EventListeners;
+}
+
+interface PreferencesStorage {
+  [key: string]: boolean | string;
+}
+
+interface InitializeAppResult {
+  options: ReactNativeFirebase.FirebaseAppOptions;
+  appConfig: ReactNativeFirebase.FirebaseAppConfig;
+}
+
+// Variables for events tracking.
+let jsReady = false;
+let jsListenerCount = 0;
+let queuedEvents: QueuedEvent[] = [];
+let jsListeners: EventListeners = {};
+
+// For compatibility we have a fake preferences storage,
+// it does not persist across app restarts.
+let fakePreferencesStorage: PreferencesStorage = {};
+
+function eventsGetListenersMap(): ListenersMap {
+  return {
+    listeners: jsListenerCount,
+    queued: queuedEvents.length,
+    events: jsListeners,
+  };
+}
+
+function eventsSendEvent(eventName: string, eventBody: any): void {
+  if (!jsReady || !jsListeners.hasOwnProperty(eventName)) {
+    const event: QueuedEvent = {
+      eventName,
+      eventBody,
+    };
+    queuedEvents.push(event);
+    return;
+  }
+  setImmediate(() => DeviceEventEmitter.emit('rnfb_' + eventName, eventBody));
+}
+
+function eventsSendQueuedEvents(): void {
+  if (queuedEvents.length === 0) {
+    return;
+  }
+  const events = Array.from(queuedEvents);
+  queuedEvents = [];
+  for (let i = 0; i < events.length; i++) {
+    const event = events[i];
+    if (event) {
+      eventsSendEvent(event.eventName, event.eventBody);
+    }
+  }
+}
+
+export default {
+  // Natively initialized apps, but in the case of web, we don't have any.
+  NATIVE_FIREBASE_APPS: [] as any[],
+  // The raw JSON string of the Firebase config, from the users firebase.json file.
+  // In the case of web, we can't support this.
+  FIREBASE_RAW_JSON: '{}',
+
+  /**
+   * Initializes a Firebase app.
+   *
+   * @param options - The Firebase app options.
+   * @param appConfig - The Firebase app config.
+   * @returns The Firebase app instance.
+   */
+  async initializeApp(
+    options: ReactNativeFirebase.FirebaseAppOptions,
+    appConfig: ReactNativeFirebase.FirebaseAppConfig,
+  ): Promise<InitializeAppResult> {
+    const name = appConfig.name;
+    const existingApp = getApps().find(app => app.name === name);
+    if (existingApp) {
+      return {
+        options,
+        appConfig,
+      };
+    }
+    const newAppConfig: any = {
+      name,
+    };
+    if (
+      appConfig.automaticDataCollectionEnabled === true ||
+      appConfig.automaticDataCollectionEnabled === false
+    ) {
+      newAppConfig.automaticDataCollectionEnabled = appConfig.automaticDataCollectionEnabled;
+    }
+    const optionsCopy = Object.assign({}, options);
+
+    delete (optionsCopy as any).clientId;
+    initializeApp(optionsCopy, newAppConfig);
+    return {
+      options,
+      appConfig,
+    };
+  },
+
+  /**
+   * Sets the log level for the Firebase app.
+   *
+   * @param logLevel - The log level to set.
+   */
+  setLogLevel(logLevel: ReactNativeFirebase.LogLevelString): void {
+    setLogLevel(logLevel as any);
+  },
+
+  /**
+   * Sets the automatic data collection for the Firebase app.
+   *
+   * @param appName - The name of the Firebase app.
+   * @param enabled - Whether to enable automatic data collection.
+   */
+  setAutomaticDataCollectionEnabled(appName: string, enabled: boolean): void {
+    (getApp(appName) as any).automaticDataCollectionEnabled = enabled;
+  },
+
+  /**
+   * Deletes a Firebase app.
+   *
+   * @param appName - The name of the Firebase app to delete.
+   */
+  async deleteApp(appName: string): Promise<void> {
+    if (getApp(appName)) {
+      await deleteApp(getApp(appName) as any);
+    }
+  },
+
+  /**
+   * Gets the meta data.
+   * Unsupported on web.
+   *
+   * @returns The meta data
+   */
+  metaGetAll(): Record<string, never> {
+    return {};
+  },
+
+  /**
+   * Gets the firebase.json data.
+   * Unsupported on web.
+   *
+   * @returns The JSON data for the firebase.json file.
+   */
+  jsonGetAll(): Record<string, never> {
+    return {};
+  },
+
+  /**
+   * Sets a boolean value for a preference.
+   * Unsupported on web.
+   *
+   * @param key - The key of the preference.
+   * @param value - The value to set.
+   */
+  async preferencesSetBool(key: string, value: boolean): Promise<void> {
+    fakePreferencesStorage[key] = value;
+  },
+
+  /**
+   * Sets a string value for a preference.
+   * Unsupported on web.
+   *
+   * @param key - The key of the preference.
+   * @param value - The value to set.
+   */
+  preferencesSetString(key: string, value: string): void {
+    fakePreferencesStorage[key] = value;
+  },
+
+  /**
+   * Gets all preferences.
+   * Unsupported on web.
+   *
+   * @returns The preferences.
+   */
+  preferencesGetAll(): PreferencesStorage {
+    return Object.assign({}, fakePreferencesStorage);
+  },
+
+  /**
+   * Clears all preferences.
+   * Unsupported on web.
+   */
+  preferencesClearAll(): void {
+    fakePreferencesStorage = {};
+  },
+
+  /**
+   * Adds a listener for an event.
+   * Unsupported on web.
+   *
+   * @param eventName - The name of the event to listen for.
+   */
+  addListener(): void {
+    // Keep: Required for RN built in Event Emitter Calls.
+  },
+  /**
+   * Removes a listener for an event.
+   * Unsupported on web.
+   *
+   * @param eventName - The name of the event to remove the listener for.
+   */
+  removeListeners(): void {
+    // Keep: Required for RN built in Event Emitter Calls.
+  },
+
+  /**
+   * Notifies the app that it is ready to receive events.
+   *
+   * @param ready - Whether the app is ready to receive events.
+   * @returns void
+   */
+  eventsNotifyReady(ready: boolean): void {
+    jsReady = ready;
+    if (jsReady) {
+      setImmediate(() => eventsSendQueuedEvents());
+    }
+  },
+
+  /**
+   * Gets all the listeners registered.
+   *
+   * @returns The listeners for the event.
+   */
+  eventsGetListeners(): ListenersMap {
+    return eventsGetListenersMap();
+  },
+
+  /**
+   * Sends an event to the app for testing purposes.
+   *
+   * @param eventName - The name of the event to send.
+   * @param eventBody - The body of the event to send.
+   * @returns void
+   */
+  eventsPing(eventName: string, eventBody: any): void {
+    eventsSendEvent(eventName, eventBody);
+  },
+
+  /**
+   * Adds a listener for an event.
+   *
+   * @param eventName - The name of the event to listen for.
+   */
+  eventsAddListener(eventName: string): void {
+    jsListenerCount++;
+    if (!jsListeners.hasOwnProperty(eventName)) {
+      jsListeners[eventName] = 1;
+    } else {
+      if (jsListeners[eventName] !== undefined) {
+        jsListeners[eventName]++;
+      }
+    }
+    setImmediate(() => eventsSendQueuedEvents());
+  },
+
+  /**
+   * Removes a single listener for an event or all listeners for an event.
+   *
+   * @param eventName - The name of the event to remove the listener for.
+   * @param all - Optional. Whether to remove all listeners for the event.
+   */
+  eventsRemoveListener(eventName: string, all?: boolean): void {
+    if (jsListeners.hasOwnProperty(eventName)) {
+      const count = jsListeners[eventName];
+      if (count !== undefined) {
+        if (count <= 1 || all) {
+          jsListenerCount -= count;
+          delete jsListeners[eventName];
+        } else {
+          jsListenerCount--;
+          const currentCount = jsListeners[eventName];
+          if (currentCount !== undefined) {
+            jsListeners[eventName] = currentCount - 1;
+          }
+        }
+      }
+    }
+  },
+};

package/{ios/RNFBApp/RCTConvert+FIRApp.h → lib/internal/web/firebaseApp.ts}

@@ -1,4 +1,4 @@
-/**
+/*
  * Copyright (c) 2016-present Invertase Limited & Contributors
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -15,9 +15,6 @@
  *
  */
 
-#import <FirebaseCore/FirebaseCore.h>
-#import <React/RCTConvert.h>
-
-@interface RCTConvert (FIRApp)
-+ (FIRApp *)firAppFromString:(NSString *)appName;
-@end
+// We need to share firebase imports between modules, otherwise
+// apps and instances of the firebase modules are not shared.
+export * from 'firebase/app';

package/lib/internal/web/firebaseAppCheck.ts

@@ -0,0 +1,23 @@
+/*
+ * Copyright (c) 2016-present Invertase Limited & Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this library except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+// We need to share firebase imports between modules, otherwise
+// apps and instances of the firebase modules are not shared.
+import 'firebase/app';
+export { getApp } from 'firebase/app';
+export * from 'firebase/app-check';
+export { makeIDBAvailable } from './memidb';

package/lib/internal/web/firebaseAuth.ts

@@ -0,0 +1,21 @@
+/*
+ * Copyright (c) 2016-present Invertase Limited & Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this library except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+// We need to share firebase imports between modules, otherwise
+// apps and instances of the firebase modules are not shared.
+export * from 'firebase/app';
+export * from 'firebase/auth';

package/lib/internal/web/firebaseDatabase.ts

@@ -0,0 +1,21 @@
+/*
+ * Copyright (c) 2016-present Invertase Limited & Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this library except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+// We need to share firebase imports between modules, otherwise
+// apps and instances of the firebase modules are not shared.
+export * from 'firebase/app';
+export * from 'firebase/database';

package/{android/src/reactnative/java/io/invertase/firebase/app/ReactNativeFirebaseAppInitProvider.java → lib/internal/web/firebaseFirestore.ts}

@@ -1,5 +1,3 @@
-package io.invertase.firebase.app;
-
 /*
  * Copyright (c) 2016-present Invertase Limited & Contributors
  *
@@ -17,6 +15,7 @@ package io.invertase.firebase.app;
  *
  */
 
-import io.invertase.firebase.common.ReactNativeFirebaseInitProvider;
-
-public class ReactNativeFirebaseAppInitProvider extends ReactNativeFirebaseInitProvider {}
+// We need to share firebase imports between modules, otherwise
+// apps and instances of the firebase modules are not shared.
+export { getApp } from 'firebase/app';
+export * from 'firebase/firestore/lite';

package/lib/internal/web/firebaseFunctions.ts

@@ -0,0 +1,21 @@
+/*
+ * Copyright (c) 2016-present Invertase Limited & Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this library except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+// We need to share firebase imports between modules, otherwise
+// apps and instances of the firebase modules are not shared.
+export * from 'firebase/app';
+export * from 'firebase/functions';

package/lib/internal/web/firebaseInstallations.ts

@@ -0,0 +1,23 @@
+/*
+ * Copyright (c) 2016-present Invertase Limited & Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this library except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+// We need to share firebase imports between modules, otherwise
+// apps and instances of the firebase modules are not shared.
+import 'firebase/app';
+export { getApp } from 'firebase/app';
+export * from 'firebase/installations';
+export { makeIDBAvailable } from './memidb';

package/lib/internal/web/firebaseRemoteConfig.ts

@@ -0,0 +1,23 @@
+/*
+ * Copyright (c) 2016-present Invertase Limited & Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this library except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+// We need to share firebase imports between modules, otherwise
+// apps and instances of the firebase modules are not shared.
+import 'firebase/app';
+export { getApp } from 'firebase/app';
+export * from 'firebase/remote-config';
+export { makeIDBAvailable } from './memidb';

package/lib/internal/web/firebaseStorage.ts

@@ -0,0 +1,21 @@
+/*
+ * Copyright (c) 2016-present Invertase Limited & Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this library except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+// We need to share firebase imports between modules, otherwise
+// apps and instances of the firebase modules are not shared.
+export * from 'firebase/app';
+export * from 'firebase/storage';

package/{ios/RNFBApp/RNFBVersion.h → lib/internal/web/memidb/index.d.ts}

@@ -1,4 +1,4 @@
-/**
+/*
  * Copyright (c) 2016-present Invertase Limited & Contributors
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -15,6 +15,7 @@
  *
  */
 
-#import <Foundation/Foundation.h>
-
-extern const NSString* RNFBVersionString;
+/**
+ * Makes IndexedDB available in environments that don't have it
+ */
+export function makeIDBAvailable(): void;

package/lib/internal/web/memidb/lib/errors.js

@@ -1,3 +1,20 @@
+// Polyfill DOMException for React Native environments (macOS, etc.)
+// This is needed because DOMException is a web API that doesn't exist in React Native
+if (typeof DOMException === 'undefined') {
+  const DOMExceptionPolyfill = class DOMException extends Error {
+    constructor(message = '', name = 'Error') {
+      super(message);
+      this.name = name;
+      this.message = message;
+    }
+  };
+  // Set on both global and globalThis for compatibility
+  global.DOMException = DOMExceptionPolyfill;
+  if (typeof globalThis !== 'undefined') {
+    globalThis.DOMException = DOMExceptionPolyfill;
+  }
+}
+
 const messages = {
   AbortError: 'A request was aborted, for example through a call to IDBTransaction.abort.',
   ConstraintError:

package/lib/internal/web/utils.ts

@@ -0,0 +1,57 @@
+/*
+ * Copyright (c) 2016-present Invertase Limited & Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this library except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+import { DeviceEventEmitter } from 'react-native';
+
+// A general purpose guard function to catch errors and return a structured error object.
+export function guard<T>(fn: () => Promise<T>): Promise<T> {
+  return fn().catch(e => Promise.reject(getWebError(e)));
+}
+
+// Converts a thrown error to a structured error object
+// required by RNFirebase native module internals.
+export function getWebError(error: Error & { code?: string }): {
+  code: string;
+  message: string;
+  userInfo: { code: string; message: string };
+} {
+  const obj = {
+    code: error.code || 'unknown',
+    message: error.message,
+  };
+
+  // Some modules send codes as PERMISSION_DENIED, which is not
+  // the same as the Firebase error code format.
+  obj.code = obj.code.toLowerCase();
+  // Replace _ with - in code
+  obj.code = obj.code.replace(/_/g, '-');
+
+  // Split out prefix, since we internally prefix all error codes already.
+  if (obj.code.includes('/')) {
+    const parts = obj.code.split('/');
+    obj.code = parts[1] || obj.code;
+  }
+
+  return {
+    ...obj,
+    userInfo: obj,
+  };
+}
+
+export function emitEvent(eventName: string, event: unknown): void {
+  setImmediate(() => DeviceEventEmitter.emit('rnfb_' + eventName, event));
+}