@react-native-firebase/crashlytics 18.3.2 → 18.4.0

package/CHANGELOG.md

@@ -3,6 +3,12 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [18.4.0](https://github.com/invertase/react-native-firebase/compare/v18.3.2...v18.4.0) (2023-09-11)
+
+### Features
+
+- **crashlytics:** Firbase web modular V9 API ([#7283](https://github.com/invertase/react-native-firebase/issues/7283)) ([57f7327](https://github.com/invertase/react-native-firebase/commit/57f7327da4b405dace6b040e8a942d5f107f3603))
+
 ## [18.3.2](https://github.com/invertase/react-native-firebase/compare/v18.3.1...v18.3.2) (2023-09-02)
 
 ### Bug Fixes

package/lib/index.d.ts

@@ -77,7 +77,7 @@ export namespace FirebaseCrashlyticsTypes {
      * ```
      *
      */
-    isCrashlyticsCollectionEnabled: true;
+    isCrashlyticsCollectionEnabled: boolean;
     /**
      * Determines whether there are any unsent crash reports cached on the device. The callback only executes
      * if automatic data collection is disabled.

package/lib/index.js

@@ -139,6 +139,8 @@ class FirebaseCrashlyticsModule extends FirebaseModule {
   }
 }
 
+export * from './modular';
+
 // import { SDK_VERSION } from '@react-native-firebase/crashlytics';
 export const SDK_VERSION = version;
 

package/lib/modular/index.d.ts

@@ -0,0 +1,207 @@
+import { FirebaseCrashlyticsTypes } from '..';
+
+type FirebaseCrashlytics = FirebaseCrashlyticsTypes.Module;
+
+/**
+ * Returns Crashlytics instance.
+ * #### Example
+ * ```js
+ * const crashlytics = getCrashlytics();
+ * ```
+ */
+export declare function getCrashlytics(): FirebaseCrashlytics;
+
+/**
+ * Whether Crashlytics reporting is enabled.
+ *
+ * #### Example
+ *
+ * ```js
+ * const crashlytics = getCrashlytics();
+ * const isEnabled = isCrashlyticsCollectionEnabled(crashlytics);
+ * ```
+ */
+export declare function isCrashlyticsCollectionEnabled(crashlytics: FirebaseCrashlytics): boolean;
+/**
+ * Determines whether there are any unsent crash reports cached on the device. The callback only executes
+ * if automatic data collection is disabled.
+ *
+ * #### Example
+ *
+ * ```js
+ * async checkReports() {
+ * // returns boolean value
+ *  const crashlytics = getCrashlytics();
+ *  const unsentReports = await checkForUnsentReports(crashlytics);
+ * }
+ *
+ * checkReports();
+ * ```
+ */
+export declare function checkForUnsentReports(crashlytics: FirebaseCrashlytics): Promise<boolean>;
+/**
+ * Deletes any unsent reports on the device. This method only applies if automatic data collection is
+ * disabled.
+ *
+ * #### Example
+ *
+ * ```js
+ * const crashlytics = getCrashlytics();
+ * deleteUnsentReports(crashlytics);
+ * ```
+ */
+export declare function deleteUnsentReports(crashlytics: FirebaseCrashlytics): Promise<void>;
+/**
+ * Returns a boolean value indicating whether the app crashed during the previous execution.
+ *
+ * #### Example
+ *
+ * ```js
+ * async didCrashPreviously() {
+ * // returns boolean value
+ * const crashlytics = getCrashlytics();
+ * const didCrash = await didCrashOnPreviousExecution(crashlytics);
+ * }
+ *
+ * didCrashPreviously();
+ * ```
+ */
+export declare function didCrashOnPreviousExecution(
+  crashlytics: FirebaseCrashlytics,
+): 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. Additionally
+ * if it is a debug build you will need to ensure your firebase.json is configured to enable crashlytics even in debug mode.
+ *
+ * #### Example
+ *
+ * ```js
+ * const crashlytics = getCrashlytics();
+ * crash(crashlytics);
+ * ```
+ */
+export declare function crash(crashlytics: FirebaseCrashlytics): void;
+
+/**
+ * Log a message that will appear in any subsequent Crash or Non-fatal error reports.
+ *
+ * #### Example
+ *
+ * ```js
+ * const crashlytics = getCrashlytics();
+ * log(crashlytics, 'Testing a crash');
+ * crash(crashlytics);
+ * ```
+ */
+export declare function log(crashlytics: FirebaseCrashlytics, message: string): void;
+
+/**
+ * Record a JavaScript Error.
+ *
+ * The JavaScript stack trace is converted into a mock native iOS or Android exception before submission.
+ * The line numbers in the stack trace (if available) will be relative to the javascript bundle built by your packager,
+ * after whatever transpilation or minimization steps happen. You will need to maintain sourcemaps to decode them if desired.
+ *
+ * #### Example
+ *
+ * ```js
+ * const crashlytics = getCrashlytics();
+ * recordError(
+ *  crashlytics,
+ *  new Error('An error was caught')
+ * );
+ * ```
+ */
+export declare function recordError(
+  crashlytics: FirebaseCrashlytics,
+  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.
+ *
+ * #### Example
+ *
+ * ```js
+ * const crashlytics = getCrashlytics();
+ * sendUnsentReports(crashlytics);
+ * ```
+ */
+export declare function sendUnsentReports(crashlytics: FirebaseCrashlytics): void;
+
+/**
+ * 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.
+ *
+ * #### Example
+ *
+ * ```js
+ * const auth = getAuth();
+ * const crashlytics = getCrashlytics();
+ * // Custom user id
+ * await setUserId(crashlytics, '123456789');
+ * // Firebase auth uid
+ * await setUserId(
+ *  crashlytics,
+ *  auth.currentUser.uid
+ * );
+ * ```
+ */
+export declare function setUserId(crashlytics: FirebaseCrashlytics, userId: string): Promise<null>;
+
+/**
+ * Sets a string value to be associated with the given attribute name which will be visible in the Firebase Crashlytics console.
+ *
+ * #### Example
+ *
+ * ```js
+ * const crashlytics = getCrashlytics();
+ * await setAttribute(crashlytics, 'role', 'admin');
+ * ```
+ */
+export declare function setAttribute(
+  crashlytics: FirebaseCrashlytics,
+  name: string,
+  value: string,
+): Promise<null>;
+
+/**
+ * Like `setAttribute` but for multiple attributes.
+ *
+ * #### Example
+ *
+ * ```js
+ * const crashlytics = getCrashlytics();
+ * await setAttributes(crashlytics, {
+ *   role: 'admin',
+ *   followers: '13',
+ * });
+ * ```
+ */
+export declare function setAttributes(
+  crashlytics: FirebaseCrashlytics,
+  attributes: { [key: string]: 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.
+ *
+ * #### Example
+ *
+ * ```js
+ * const crashlytics = getCrashlytics();
+ * // Disable crash reporting
+ * await setCrashlyticsCollectionEnabled(crashlytics, false);
+ * ```
+ */
+export declare function setCrashlyticsCollectionEnabled(
+  crashlytics: FirebaseCrashlytics,
+  enabled: boolean,
+): Promise<null>;

package/lib/modular/index.js

@@ -0,0 +1,118 @@
+import { firebase } from '..';
+
+/**
+ * @typedef {import("..").FirebaseApp} FirebaseApp
+ * @typedef {import("..").FirebaseCrashlyticsTypes.Module} FirebaseCrashlytics
+ */
+
+/**
+ * @param {FirebaseApp} app
+ * @returns {FirebaseCrashlytics}
+ */
+export function getCrashlytics() {
+  return firebase.crashlytics();
+}
+
+/**
+ * @param {FirebaseCrashlytics} crashlytics
+ * @returns {boolean}
+ */
+export function isCrashlyticsCollectionEnabled(crashlytics) {
+  return crashlytics.isCrashlyticsCollectionEnabled;
+}
+
+/**
+ * @param {FirebaseCrashlytics} crashlytics
+ * @returns {Promise<boolean>}
+ */
+export function checkForUnsentReports(crashlytics) {
+  return crashlytics.checkForUnsentReports();
+}
+
+/**
+ * @param {FirebaseCrashlytics} crashlytics
+ * @returns {Promise<void>}
+ */
+export function deleteUnsentReports(crashlytics) {
+  return crashlytics.deleteUnsentReports();
+}
+
+/**
+ * @param {FirebaseCrashlytics} crashlytics
+ * @returns {Promise<boolean>}
+ */
+export function didCrashOnPreviousExecution(crashlytics) {
+  return crashlytics.didCrashOnPreviousExecution();
+}
+
+/**
+ * @param {FirebaseCrashlytics} crashlytics
+ * @returns {void}
+ */
+export function crash(crashlytics) {
+  return crashlytics.crash();
+}
+
+/**
+ * @param {FirebaseCrashlytics} crashlytics
+ * @param {string} message
+ * @returns {void}
+ */
+export function log(crashlytics, message) {
+  return crashlytics.log(message);
+}
+
+/**
+ * @param {FirebaseCrashlytics} crashlytics
+ * @param {Error} error
+ * @param {string | undefined} jsErrorName
+ * @returns {void}
+ */
+export function recordError(crashlytics, error, jsErrorName) {
+  return crashlytics.recordError(error, jsErrorName);
+}
+
+/**
+ * @param {FirebaseCrashlytics} crashlytics
+ * @returns {void}
+ */
+export function sendUnsentReports(crashlytics) {
+  return crashlytics.sendUnsentReports();
+}
+
+/**
+ * @param {FirebaseCrashlytics} crashlytics
+ * @param {string} userId
+ * @returns {Promise<null>}
+ */
+export function setUserId(crashlytics, userId) {
+  return crashlytics.setUserId(userId);
+}
+
+/**
+ * @param {FirebaseCrashlytics} crashlytics
+ * @param {string} name
+ * @param {string} value
+ * @returns {Promise<null>}
+ */
+export function setAttribute(crashlytics, name, value) {
+  return crashlytics.setAttribute(name, value);
+}
+
+/**
+ * @param {FirebaseCrashlytics} crashlytics
+ * @param {{ [key: string]: string }} attributes
+ * @returns {Promise<null>}
+ */
+export function setAttributes(crashlytics, attributes) {
+  return crashlytics.setAttributes(attributes);
+}
+
+/**
+ * @param {FirebaseCrashlytics} crashlytics
+ * @param {boolean} enabled
+ * @returns {Promise<null>}
+ */
+export function setCrashlyticsCollectionEnabled(crashlytics, enabled) {
+  return crashlytics.setCrashlyticsCollectionEnabled(enabled);
+}

package/lib/version.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-native-firebase/crashlytics",
-  "version": "18.3.2",
+  "version": "18.4.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",
@@ -29,7 +29,7 @@
     "crashlytics"
   ],
   "peerDependencies": {
-    "@react-native-firebase/app": "18.3.2",
+    "@react-native-firebase/app": "18.4.0",
     "expo": ">=47.0.0"
   },
   "dependencies": {
@@ -46,5 +46,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "f323891622441c9d59a25ef37b19534db512b372"
+  "gitHead": "5f6460a87970d8b6013530de980bc760ddc70f90"
 }