@react-native-firebase/crashlytics 23.7.0 → 23.8.0

package/lib/{index.js → namespaced.ts}

@@ -25,6 +25,7 @@ import {
   isOther,
   MODULAR_DEPRECATION_ARG,
 } from '@react-native-firebase/app/lib/common';
+import type { ModuleConfig } from '@react-native-firebase/app/lib/internal';
 import {
   createModuleNamespace,
   FirebaseModule,
@@ -36,28 +37,36 @@ import {
   setGlobalErrorHandler,
   setOnUnhandledPromiseRejectionHandler,
 } from './handlers';
-import version from './version';
+import { version } from './version';
+import type { Crashlytics, Statics } from './types/crashlytics';
+import type { ReactNativeFirebase } from '@react-native-firebase/app';
 
-const statics = {};
+const statics: Partial<Statics> = {};
 
 const namespace = 'crashlytics';
 
 const nativeModuleName = 'RNFBCrashlyticsModule';
 
 class FirebaseCrashlyticsModule extends FirebaseModule {
-  constructor(...args) {
-    super(...args);
+  _isCrashlyticsCollectionEnabled: boolean;
+
+  constructor(
+    app: ReactNativeFirebase.FirebaseAppBase,
+    config: ModuleConfig,
+    customUrlOrRegion?: string | null,
+  ) {
+    super(app, config, customUrlOrRegion);
     setGlobalErrorHandler(this.native);
     setOnUnhandledPromiseRejectionHandler(this.native);
     this._isCrashlyticsCollectionEnabled = this.native.isCrashlyticsCollectionEnabled;
   }
 
-  get isCrashlyticsCollectionEnabled() {
+  get isCrashlyticsCollectionEnabled(): boolean {
     // Purposefully did not deprecate this as I think it should remain a property rather than a method.
     return this._isCrashlyticsCollectionEnabled;
   }
 
-  checkForUnsentReports() {
+  checkForUnsentReports(): Promise<boolean> {
     if (this.isCrashlyticsCollectionEnabled) {
       throw new Error(
         "firebase.crashlytics().setCrashlyticsCollectionEnabled(*) has been set to 'true', all reports are automatically sent.",
@@ -66,23 +75,23 @@ class FirebaseCrashlyticsModule extends FirebaseModule {
     return this.native.checkForUnsentReports();
   }
 
-  crash() {
+  crash(): void {
     this.native.crash();
   }
 
-  async deleteUnsentReports() {
+  async deleteUnsentReports(): Promise<void> {
     await this.native.deleteUnsentReports();
   }
 
-  didCrashOnPreviousExecution() {
+  didCrashOnPreviousExecution(): Promise<boolean> {
     return this.native.didCrashOnPreviousExecution();
   }
 
-  log(message) {
+  log(message: string): void {
     this.native.log(`${message}`);
   }
 
-  setAttribute(name, value) {
+  setAttribute(name: string, value: string): Promise<null> {
     if (!isString(name)) {
       throw new Error(
         'firebase.crashlytics().setAttribute(*, _): The supplied property name must be a string.',
@@ -98,7 +107,7 @@ class FirebaseCrashlyticsModule extends FirebaseModule {
     return this.native.setAttribute(name, value);
   }
 
-  setAttributes(object) {
+  setAttributes(object: { [key: string]: string }): Promise<null> {
     if (!isObject(object)) {
       throw new Error(
         'firebase.crashlytics().setAttributes(*): The supplied arg must be an object of key value strings.',
@@ -108,7 +117,7 @@ class FirebaseCrashlyticsModule extends FirebaseModule {
     return this.native.setAttributes(object);
   }
 
-  setUserId(userId) {
+  setUserId(userId: string): Promise<null> {
     if (!isString(userId)) {
       throw new Error(
         'firebase.crashlytics().setUserId(*): The supplied userId must be a string value.',
@@ -118,7 +127,7 @@ class FirebaseCrashlyticsModule extends FirebaseModule {
     return this.native.setUserId(userId);
   }
 
-  recordError(error, jsErrorName) {
+  recordError(error: Error, jsErrorName?: string): void {
     if (isError(error)) {
       StackTrace.fromError(error, { offline: true }).then(stackFrames => {
         this.native.recordError(createNativeErrorObj(error, stackFrames, false, jsErrorName));
@@ -130,13 +139,13 @@ class FirebaseCrashlyticsModule extends FirebaseModule {
     }
   }
 
-  sendUnsentReports() {
+  sendUnsentReports(): void {
     if (this.isCrashlyticsCollectionEnabled) {
       this.native.sendUnsentReports();
     }
   }
 
-  setCrashlyticsCollectionEnabled(enabled) {
+  setCrashlyticsCollectionEnabled(enabled: boolean): Promise<null> {
     if (!isBoolean(enabled)) {
       throw new Error(
         "firebase.crashlytics().setCrashlyticsCollectionEnabled(*) 'enabled' must be a boolean.",
@@ -148,14 +157,10 @@ class FirebaseCrashlyticsModule extends FirebaseModule {
   }
 }
 
-export * from './modular';
-
 // import { SDK_VERSION } from '@react-native-firebase/crashlytics';
 export const SDK_VERSION = version;
 
-// import crashlytics from '@react-native-firebase/crashlytics';
-// crashlytics().X(...);
-export default createModuleNamespace({
+const crashlyticsNamespace = createModuleNamespace({
   statics,
   version,
   namespace,
@@ -166,12 +171,36 @@ export default createModuleNamespace({
   ModuleClass: FirebaseCrashlyticsModule,
 });
 
+type CrashlyticsNamespace = ReactNativeFirebase.FirebaseModuleWithStaticsAndApp<
+  Crashlytics,
+  Statics
+> & {
+  crashlytics: ReactNativeFirebase.FirebaseModuleWithStaticsAndApp<Crashlytics, Statics>;
+  firebase: ReactNativeFirebase.Module;
+  app(name?: string): ReactNativeFirebase.FirebaseApp;
+};
+
+// import crashlytics from '@react-native-firebase/crashlytics';
+// crashlytics().X(...);
+export default crashlyticsNamespace as unknown as CrashlyticsNamespace;
+
 // import crashlytics, { firebase } from '@react-native-firebase/crashlytics';
 // crashlytics().X(...);
 // firebase.crashlytics().X(...);
-export const firebase = getFirebaseRoot();
+export const firebase =
+  getFirebaseRoot() as unknown as ReactNativeFirebase.FirebaseNamespacedExport<
+    'crashlytics',
+    Crashlytics,
+    Statics,
+    false
+  >;
+
+// Register the interop module for non-native platforms.
+// Note: This package doesn't have a web fallback module like functions does
+// setReactNativeModule(nativeModuleName, fallBackModule);
 
 // This will throw with 'Default App Not initialized' if the default app is not configured.
 if (!isOther) {
+  // @ts-ignore - Extra arg used by deprecation proxy to detect namespaced calls
   firebase.crashlytics.call(null, getApp(), MODULAR_DEPRECATION_ARG);
 }

package/lib/types/crashlytics.ts

@@ -0,0 +1,159 @@
+/*
+ * 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 type { ReactNativeFirebase } from '@react-native-firebase/app';
+
+// ============ Module Interface ============
+
+/**
+ * Crashlytics module instance - returned from firebase.crashlytics() or firebase.app().crashlytics()
+ */
+export interface Crashlytics extends ReactNativeFirebase.FirebaseModule {
+  /** The FirebaseApp this module is associated with */
+  app: ReactNativeFirebase.FirebaseApp;
+
+  /**
+   * Whether Crashlytics reporting is enabled.
+   */
+  readonly isCrashlyticsCollectionEnabled: boolean;
+
+  /**
+   * Determines whether there are any unsent crash reports cached on the device.
+   * The callback only executes if automatic data collection is disabled.
+   *
+   * @throws Error if Crashlytics collection is enabled (reports are automatically sent)
+   */
+  checkForUnsentReports(): Promise<boolean>;
+
+  /**
+   * Cause your app to crash for testing purposes. This is a native crash and will not contain a javascript stack trace.
+   * Note that crashes are intercepted by debuggers on iOS so no report will be seen under those conditions.
+   */
+  crash(): void;
+
+  /**
+   * Deletes any unsent reports on the device. This method only applies if automatic data collection is disabled.
+   */
+  deleteUnsentReports(): Promise<void>;
+
+  /**
+   * Returns a boolean value indicating whether the app crashed during the previous execution.
+   */
+  didCrashOnPreviousExecution(): Promise<boolean>;
+
+  /**
+   * Log a message that will appear in any subsequent Crash or Non-fatal error reports.
+   *
+   * @param message The message to log.
+   */
+  log(message: string): void;
+
+  /**
+   * Record a JavaScript Error.
+   *
+   * The JavaScript stack trace is converted into a mock native iOS or Android exception before submission.
+   *
+   * @param error Expects an instance of Error; e.g. classes that extend Error will also be supported.
+   * @param jsErrorName Optional string containing Javascript error name
+   */
+  recordError(error: Error, jsErrorName?: string): void;
+
+  /**
+   * Enqueues any unsent reports on the device to upload to Crashlytics. This method only applies if
+   * automatic data collection is disabled.
+   */
+  sendUnsentReports(): void;
+
+  /**
+   * Sets a string value to be associated with the given attribute name which will be visible in the Firebase Crashlytics console.
+   *
+   * @param name The name of the attribute to set.
+   * @param value A string value for the given attribute.
+   */
+  setAttribute(name: string, value: string): Promise<null>;
+
+  /**
+   * Like `setAttribute` but for multiple attributes.
+   *
+   * @param attributes An object of key/value attribute name and values.
+   */
+  setAttributes(attributes: { [key: string]: string }): Promise<null>;
+
+  /**
+   * Specify a user identifier which will be visible in the Firebase Crashlytics console.
+   *
+   * It is recommended for privacy purposes that this value be a value that's meaningless to a third-party
+   * observer; such as an arbitrary string that ties an end-user to a record in your system e.g. a database record id.
+   *
+   * @param userId An arbitrary string that ties an end-user to a record in your system e.g. a database record id.
+   */
+  setUserId(userId: string): Promise<null>;
+
+  /**
+   * Enable/disable Crashlytics reporting.
+   *
+   * Use this for opt-in first user data collection flows combined with `firebase.json` settings to disable auto collection.
+   *
+   * @param enabled A boolean value representing whether to enable Crashlytics error collection.
+   */
+  setCrashlyticsCollectionEnabled(enabled: boolean): Promise<null>;
+}
+
+// ============ Statics Interface ============
+
+/**
+ * Static properties available on firebase.crashlytics
+ */
+export interface Statics {
+  SDK_VERSION: string;
+}
+
+/**
+ * FirebaseApp type with crashlytics() method.
+ * @deprecated Import FirebaseApp from '@react-native-firebase/app' instead.
+ * The crashlytics() method is added via module augmentation.
+ */
+export type FirebaseApp = ReactNativeFirebase.FirebaseApp;
+
+// ============ Module Augmentation ============
+
+/* eslint-disable @typescript-eslint/no-namespace */
+declare module '@react-native-firebase/app' {
+  namespace ReactNativeFirebase {
+    interface Module {
+      crashlytics: FirebaseModuleWithStaticsAndApp<Crashlytics, Statics>;
+    }
+    interface FirebaseApp {
+      crashlytics(): Crashlytics;
+    }
+  }
+}
+/* eslint-enable @typescript-eslint/no-namespace */
+// ============ Backwards Compatibility Namespace - to be removed with namespaced exports ============
+type _Statics = Statics;
+
+/**
+ * @deprecated Use the exported types directly instead.
+ * FirebaseCrashlyticsTypes namespace is kept for backwards compatibility.
+ */
+/* eslint-disable @typescript-eslint/no-namespace */
+export namespace FirebaseCrashlyticsTypes {
+  // Short name aliases referencing top-level types
+  export type Module = Crashlytics;
+  export type Statics = _Statics;
+}
+/* eslint-enable @typescript-eslint/no-namespace */

package/lib/version.ts

@@ -0,0 +1,2 @@
+// Generated by genversion.
+export const version = '23.8.0';

package/package.json

@@ -1,16 +1,18 @@
 {
   "name": "@react-native-firebase/crashlytics",
-  "version": "23.7.0",
+  "version": "23.8.0",
   "author": "Invertase <oss@invertase.io> (http://invertase.io)",
   "description": "React Native Firebase - Firebase Crashlytics is a lightweight, realtime crash reporter that helps you track, prioritize, and fix stability issues that erode your app quality. React Native Firebase provides automatic crash reporting for both native and JavaScript errors, including unhandled promise rejections.",
-  "main": "lib/index.js",
-  "types": "lib/index.d.ts",
+  "main": "./dist/commonjs/index.js",
+  "module": "./dist/module/index.js",
+  "types": "./dist/typescript/commonjs/lib/index.d.ts",
   "scripts": {
-    "build": "genversion --semi lib/version.js",
+    "build": "genversion --esm --semi lib/version.ts",
     "build:clean": "rimraf android/build && rimraf ios/build",
     "build:plugin": "rimraf plugin/build && tsc --build plugin",
     "lint:plugin": "eslint plugin/src/*",
-    "prepare": "yarn run build && yarn run build:plugin"
+    "compile": "bob build",
+    "prepare": "yarn run build && yarn run build:plugin && yarn compile"
   },
   "repository": {
     "type": "git",
@@ -29,14 +31,16 @@
     "crashlytics"
   ],
   "peerDependencies": {
-    "@react-native-firebase/app": "23.7.0",
+    "@react-native-firebase/app": "23.8.0",
     "expo": ">=47.0.0"
   },
   "dependencies": {
     "stacktrace-js": "^2.0.2"
   },
   "devDependencies": {
-    "expo": "^54.0.27"
+    "expo": "^54.0.27",
+    "react-native-builder-bob": "^0.40.12",
+    "typescript": "^5.8.3"
   },
   "peerDependenciesMeta": {
     "expo": {
@@ -47,5 +51,53 @@
     "access": "public",
     "provenance": true
   },
-  "gitHead": "2a30c0b1e41a2b239172afd167f98a03fd422f2c"
+  "exports": {
+    ".": {
+      "source": "./lib/index.ts",
+      "import": {
+        "types": "./dist/typescript/module/lib/index.d.ts",
+        "default": "./dist/module/index.js"
+      },
+      "require": {
+        "types": "./dist/typescript/commonjs/lib/index.d.ts",
+        "default": "./dist/commonjs/index.js"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "lib",
+    "plugin/src",
+    "tsconfig.json",
+    "plugin/tsconfig.json",
+    "dist",
+    "!**/__tests__",
+    "!**/__fixtures__",
+    "!**/__mocks__"
+  ],
+  "react-native-builder-bob": {
+    "source": "lib",
+    "output": "dist",
+    "targets": [
+      [
+        "module",
+        {
+          "esm": true
+        }
+      ],
+      [
+        "commonjs",
+        {
+          "esm": true
+        }
+      ],
+      [
+        "typescript",
+        {
+          "tsc": "../../node_modules/.bin/tsc"
+        }
+      ]
+    ]
+  },
+  "gitHead": "724ddcfea6ebe93875e5a54ff38ca57ab5990822"
 }

package/tsconfig.json

@@ -0,0 +1,21 @@
+{
+  "extends": "../../tsconfig.packages.base.json",
+  "compilerOptions": {
+    "baseUrl": ".",
+    "rootDir": ".",
+    "paths": {
+      "@react-native-firebase/app/lib/common/*": ["../app/dist/typescript/commonjs/lib/common/*"],
+      "@react-native-firebase/app/lib/common": ["../app/dist/typescript/commonjs/lib/common"],
+      "@react-native-firebase/app/lib/internal/web/*": [
+        "../app/dist/typescript/commonjs/lib/internal/web/*"
+      ],
+      "@react-native-firebase/app/lib/internal/*": [
+        "../app/dist/typescript/commonjs/lib/internal/*"
+      ],
+      "@react-native-firebase/app/lib/internal": ["../app/dist/typescript/commonjs/lib/internal"],
+      "@react-native-firebase/app": ["../app/dist/typescript/commonjs/lib"]
+    }
+  },
+  "include": ["lib/**/*", "../app/lib/internal/global.d.ts"],
+  "exclude": ["node_modules", "dist", "__tests__", "**/*.test.ts"]
+}