npmpackage.info

Gathering detailed insights and metrics for @capacitor-community/firebase-crashlytics

@capacitor-community/firebase-crashlytics

⚡️ Capacitor plugin for Firebase Crashlytics.

3.0.0

MIT

Java

750,131 3

Installations

npm install @capacitor-community/firebase-crashlytics

Pull Requests

Open

1

Total

47

Closed

5

Merged

41

Issues

Open

0

Total

36

Closed

36

Releases

v3.0.0

Published on 14 May 2023

v2.0.0

Published on 24 Feb 2023

v2.0.0-1

Published on 05 Aug 2022

v2.0.0-0

Published on 05 Aug 2022

v1.3.0

Published on 08 Mar 2022

v1.2.1

Published on 26 Jan 2022

View all 13 releases

Developer

capacitor-community

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

Yes

Node Version

16.20.0

NPM Version

8.19.4 Statistics

72 Stars

171 Commits

38 Forks

14 Watching

3 Branches

27 Contributors

Updated on 09 Oct 2024

Languages

Java (38.04%)

Swift (30.41%)

TypeScript (19.91%)

Objective-C (5.36%)

Ruby (4.36%)

JavaScript (1.92%)

Total Downloads

Cumulative downloads

Total Downloads

750,131

Last day

-40.9%

243

Compared to previous day

Last week

1,543

Compared to previous week

Last month

-17.8%

5,970

Compared to previous month

Last year

-9.6%

173,365

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Peer Dependencies

@capacitor/core

Dev Dependencies

eslint rimraf rollup prettier swiftlint typescript @capacitor/cli @capacitor/ios @capacitor/core standard-version @capacitor/docgen @capacitor/android @ionic/eslint-config prettier-plugin-java @ionic/prettier-config @ionic/swiftlint-config

Versions

⚠️ Deprecated repository

This project has been moved to the following monorepo: capawesome-team/capacitor-firebase.

Firebase Crashlytics

@capacitor-community/firebase-crashlytics

Capacitor plugin for Firebase Crashlytics.

Maintainers

Maintainer	GitHub	Social
Robin Genz	robingenz	@robin_genz

Installation

npm install @capacitor-community/firebase-crashlytics
npx cap sync

Add Firebase to your project if you haven't already (Android / iOS).

Android

See Add the Firebase Crashlytics plugin to your app and follow the instructions to set up your app correctly.

Variables

This plugin will use the following project variables (defined in your app’s variables.gradle file):

$firebaseCrashlyticsVersion version of com.google.firebase:firebase-crashlytics (default: 18.2.8)

iOS

See Set up Xcode to automatically upload dSYM files and follow the instructions to set up Xcode correctly.
Attention: The path used in section 4.c of the guide should be:

1"${PODS_ROOT}/FirebaseCrashlytics/run"

Configuration

No configuration required for this plugin.

Demo

A working example can be found here: robingenz/capacitor-firebase-plugin-demo

Usage

1import { FirebaseCrashlytics } from '@capacitor-community/firebase-crashlytics';
2
3const crash = async () => {
4  await FirebaseCrashlytics.crash({ message: 'Test' });
5};
6
7const setContext = async () => {
8  await FirebaseCrashlytics.setContext({ 
9    key: 'page',
10    value: 'home',
11    type: 'string'
12  });
13};
14
15const setUserId = async () => {
16  await FirebaseCrashlytics.setUserId({
17    userId: '123'
18  });
19};
20
21const addLogMessage = async () => {
22  await FirebaseCrashlytics.addLogMessage({
23    message: 'Test'
24  });
25};
26
27const setEnabled = async () => {
28  await FirebaseCrashlytics.setEnabled({
29    enabled: true,
30  });
31};
32
33const isEnabled = async () => {
34  const result = await FirebaseCrashlytics.isEnabled();
35  return result.enabled;
36};
37
38const didCrashDuringPreviousExecution = async () => {
39  const result = await FirebaseCrashlytics.didCrashDuringPreviousExecution();
40  return result.crashed;
41};
42
43const sendUnsentReports = async () => {
44  await FirebaseCrashlytics.sendUnsentReports();
45};
46
47const deleteUnsentReports = async () => {
48  await FirebaseCrashlytics.deleteUnsentReports();
49};
50
51const recordException = async () => {
52  await FirebaseCrashlytics.recordException({
53    message: 'This is a non-fatal message.'
54  });
55};
56
57import * as StackTrace from 'stacktrace-js';
58
59const recordExceptionWithStacktrace = async (error: Error) => {
60    const stacktrace = await StackTrace.fromError(error);
61    await FirebaseCrashlytics.recordException({
62        message: 'This is a non-fatal message.',
63        stacktrace
64    });
65};

crash(...)

1crash(options: { message: string; }) => Promise<void>

Forces a crash to test the implementation.

Only available for Android and iOS.

Param	Type
`options`	`{ message: string; }`

setContext(...)

1setContext(options: ContextOptions) => Promise<void>

Sets a custom key and value that is associated with subsequent fatal and non-fatal reports.

Only available for Android and iOS.

Param	Type
`options`	`ContextOptions`

setUserId(...)

1setUserId(options: { userId: string; }) => Promise<void>

Sets a user ID (identifier) that is associated with subsequent fatal and non-fatal reports.

Only available for Android and iOS.

Param	Type
`options`	`{ userId: string; }`

addLogMessage(...)

1addLogMessage(options: { message: string; }) => Promise<void>

Adds a log message that is sent with your crash data. Only visible in the Crashlytics dashboard.

Only available for Android and iOS.

Param	Type
`options`	`{ message: string; }`

setEnabled(...)

1setEnabled(options: { enabled: boolean; }) => Promise<void>

Enables/disables automatic data collection. The value does not apply until the next run of the app.

Only available for Android and iOS.

Param	Type
`options`	`{ enabled: boolean; }`

isEnabled()

1isEnabled() => Promise<{ enabled: boolean; }>

Returns whether or not automatic data collection is enabled.

Only available for iOS.

Returns: Promise<{ enabled: boolean; }>

didCrashDuringPreviousExecution()

1didCrashDuringPreviousExecution() => Promise<{ crashed: boolean; }>

Returns whether the app crashed during the previous execution.

Only available for Android and iOS.

Returns: Promise<{ crashed: boolean; }>

sendUnsentReports()

1sendUnsentReports() => Promise<void>

Uploads any unsent reports to Crashlytics. When automatic data collection is enabled, Crashlytics automatically uploads reports at startup.

Only available for Android and iOS.

deleteUnsentReports()

1deleteUnsentReports() => Promise<void>

Deletes any unsent reports on the device.

Only available for Android and iOS.

recordException(...)

1recordException(options: RecordExceptionOptions) => Promise<void>

Records a non-fatal report to send to Crashlytics.

Only available for Android and iOS.

Param	Type
`options`	`RecordExceptionOptions`

Interfaces

ContextOptions

Prop	Type
`key`	`string`
`value`	`string \| number \| boolean`
`type`	`'string' \| 'boolean' \| 'long' \| 'double' \| 'int' \| 'float'`

RecordExceptionOptions

Prop	Type	Description
`message`	`string`
`code`	`number`	Error code within a specific error domain. This option is ignored when `stacktrace` is provided. Only available for iOS.
`domain`	`string`	A string containing the error domain. This option is ignored when `stacktrace` is provided. Only available for iOS.
`stacktrace`	`StackFrame[]`	A stacktrace generated by `stacktrace.js`. Cannot be combined with `code` and `domain`.

StackFrame

Subset of the Stacktrace generated by stacktrace.js.

Prop	Type
`lineNumber`	`number`
`fileName`	`string`
`functionName`	`string`

Test your implementation

Here you can find more information on how to test the Firebase Crashlytics implementation. Among other things, you will find information on how to correctly adjust the project's debug settings under iOS and how to test it out.

If you get obfuscated crash reports for iOS, make sure you have initialized Crashlytics correctly and take a look at this guide, which provides some ways to troubleshoot if Crashlytics can't find your app's dSYM.

Changelog

See CHANGELOG.md.

License

See LICENSE.

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

9

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

4

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 4

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/capacitor-community/firebase-crashlytics/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/capacitor-community/firebase-crashlytics/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/capacitor-community/firebase-crashlytics/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:39: update your workflow using https://app.stepsecurity.io/secureworkflow/capacitor-community/firebase-crashlytics/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:48: update your workflow using https://app.stepsecurity.io/secureworkflow/capacitor-community/firebase-crashlytics/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:50: update your workflow using https://app.stepsecurity.io/secureworkflow/capacitor-community/firebase-crashlytics/ci.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/lock.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/capacitor-community/firebase-crashlytics/lock.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/needs-reply.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/capacitor-community/firebase-crashlytics/needs-reply.yml/master?enable=pin
Info: 0 out of 6 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 2 third-party GitHubAction dependencies pinned
Info: 2 out of 2 npmCommand dependencies pinned

4

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

0

Maintained

Determines if the project is "actively maintained".

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Security-Policy

Determines if the project has published a security policy.

0

SAST

Determines if the project uses static code analysis.

Score

3

/10

Last Scanned on 2024-11-25

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More