@honeybadger-io/react-native 0.0.7 → 0.0.10

package/index.d.ts

@@ -0,0 +1,61 @@
+export default honeybadger;
+declare namespace honeybadger {
+    /**
+     * Initialize and configure the Honeybadger React Native library.
+     * @param {string} apiKey - Your Honeybadger API key.
+     * @param {boolean} [reportErrors=true] reportErrors - Whether to send error reports to Honeybadger (disable for dev environments, etc.)
+     * @param {string=} revision - The git revision of the current build.
+     * @param {string=} projectRoot - The path to the project root.
+     */
+    function configure(apiKey: string, reportErrors?: boolean, revision?: string, projectRoot?: string): void;
+    /**
+     * Initialize and configure the Honeybadger React Native library.
+     * @param {string} apiKey - Your Honeybadger API key.
+     * @param {boolean} [reportErrors=true] reportErrors - Whether to send error reports to Honeybadger (disable for dev environments, etc.)
+     * @param {string=} revision - The git revision of the current build.
+     * @param {string=} projectRoot - The path to the project root.
+     */
+    function configure(apiKey: string, reportErrors?: boolean, revision?: string, projectRoot?: string): void;
+    /**
+     * Send any kind of error, exception, object, String, etc. to Honeybadger.
+     * @param {string|object} err - The error string or object.
+     * @param {string|object} additionalData - Additional data to include with the error.
+     */
+    function notify(err: any, additionalData: any): void;
+    /**
+     * Send any kind of error, exception, object, String, etc. to Honeybadger.
+     * @param {string|object} err - The error string or object.
+     * @param {string|object} additionalData - Additional data to include with the error.
+     */
+    function notify(err: any, additionalData: any): void;
+    /**
+     * Include additional data whenever an error or an exception occurs. This can be called as many times as needed. New context data will be merged with any previously-set context data.
+     * @param {object} context - Additional data to include with all errors and exceptions.
+     */
+    function setContext(context: any): void;
+    /**
+     * Include additional data whenever an error or an exception occurs. This can be called as many times as needed. New context data will be merged with any previously-set context data.
+     * @param {object} context - Additional data to include with all errors and exceptions.
+     */
+    function setContext(context: any): void;
+    /**
+     * Clears/resets any data previously set through setContext().
+     * @param {object=} context - Optional new context to set.
+     */
+    function resetContext(context?: any): void;
+    /**
+     * Clears/resets any data previously set through setContext().
+     * @param {object=} context - Optional new context to set.
+     */
+    function resetContext(context?: any): void;
+    /**
+     * Sets the logging level for the Honeybadger library.
+     * @param {('debug'|'warning'|'error')} [level=warning] - The logging level.
+     */
+    function setLogLevel(level?: "error" | "warning" | "debug"): void;
+    /**
+     * Sets the logging level for the Honeybadger library.
+     * @param {('debug'|'warning'|'error')} [level=warning] - The logging level.
+     */
+    function setLogLevel(level?: "error" | "warning" | "debug"): void;
+}

package/index.js

@@ -15,6 +15,9 @@ let _initialized = false;
 let _context = {};
 let _logLevel = "warning"; // "error", "warning", "debug"
 let _previousJSGlobalExceptionHandler = null;
+let _revision = "";
+let _projectRoot = "";
+let _reportErrors = true;
 
 
 
@@ -23,7 +26,14 @@ let _previousJSGlobalExceptionHandler = null;
 // ----------------------------------------------------------------------------
 const honeybadger = {
 
-    configure ( apiKey )
+    /**
+     * Initialize and configure the Honeybadger React Native library.
+     * @param {string} apiKey - Your Honeybadger API key.
+     * @param {boolean} [reportErrors=true] reportErrors - Whether to send error reports to Honeybadger (disable for dev environments, etc.)
+     * @param {string=} revision - The git revision of the current build.
+     * @param {string=} projectRoot - The path to the project root.
+     */
+    configure ( apiKey, reportErrors = true, revision = '', projectRoot = '' )
     {
         if ( !isValidAPIKey(apiKey) )
         {
@@ -32,6 +42,9 @@ const honeybadger = {
         }
 
         _apiKey = apiKey.trim();
+        _revision = (revision || '').trim();
+        _projectRoot = (projectRoot || '').trim();
+        _reportErrors = reportErrors;
 
         if ( !_initialized )
         {
@@ -41,7 +54,11 @@ const honeybadger = {
         }
     },
 
-
+    /**
+     * Send any kind of error, exception, object, String, etc. to Honeybadger.
+     * @param {string|object} err - The error string or object.
+     * @param {string|object} additionalData - Additional data to include with the error.
+     */
     notify ( err, additionalData )
     {
         if ( !isValidAPIKey(_apiKey) ) {
@@ -102,6 +119,10 @@ const honeybadger = {
     },
 
 
+    /**
+     * Include additional data whenever an error or an exception occurs. This can be called as many times as needed. New context data will be merged with any previously-set context data.
+     * @param {object} context - Additional data to include with all errors and exceptions.
+     */
     setContext ( context )
     {
         if ( isObject(context) ) {
@@ -110,12 +131,20 @@ const honeybadger = {
     },
 
 
+    /**
+     * Clears/resets any data previously set through setContext().
+     * @param {object=} context - Optional new context to set.
+     */
     resetContext ( context )
     {
         _context = (isObject(context) ? context : {});
     },
 
 
+    /**
+     * Sets the logging level for the Honeybadger library. 
+     * @param {('debug'|'warning'|'error')} [level=warning] - The logging level.
+     */
     setLogLevel ( level = "warning" )
     {
         if ( !level ) {
@@ -203,10 +232,13 @@ function setNativeExceptionHandler() {
 
 
 function sendToHoneybadger(payload) {
-    if ( !payload || !isValidAPIKey(_apiKey) ) {
+    if ( !payload || !isValidAPIKey(_apiKey) || !_reportErrors ) {
         return;
     }
 
+
+    logDebug("Sending error report to Honeybadger...");
+
     const params = {
         method: 'POST',
         headers: {
@@ -258,6 +290,8 @@ function buildPayload ( data ) {
         },
         server : {
             environment_name: (__DEV__ ? "development" : "production"),
+            project_root: _projectRoot || '',
+            revision: _revision || ''
         },
     };
 

package/package.json

@@ -1,16 +1,17 @@
 {
     "name": "@honeybadger-io/react-native",
-    "version": "0.0.7",
+    "version": "0.0.10",
     "description": "Honeybadger.io for React Native.",
     "author": "Andrey Butov <andreybutov@antair.com> (https://andreybutov.com)",
     "license": "MIT",
+    "types": "index.d.ts",
     "main": "index.js",
     "scripts": {
         "test": "echo \"Error: no test specified\" && exit 1"
     },
-	"bin": {
-		"honeybadger-generate-sourcemaps" : "./honeybadger-generate-sourcemaps.sh"
-	},
+    "bin": {
+        "honeybadger-generate-sourcemaps": "./honeybadger-generate-sourcemaps.sh"
+    },
     "repository": {
         "type": "git",
         "url": "git+ssh://git@github.com:honeybadger-io/honeybadger-react-native.git"
@@ -20,12 +21,12 @@
     ],
     "homepage": "https://github.com/honeybadger-io/honeybadger-react-native",
     "peerDependencies": {
-        "react": "^16.13.1",
+        "react": ">=16.13.1",
         "react-native": ">=0.60.0-rc.0 <1.0.x"
     },
     "devDependencies": {
-        "react": "^16.13.1",
-        "react-native": "^0.63.3"
+        "react": "=>16.13.1",
+        "react-native": "=>0.63.3",
+        "typescript": "^4.3.5"
     }
 }
-

package/tsconfig.json

@@ -0,0 +1,11 @@
+{
+	"include": ["index.js"],
+	"compilerOptions": {
+		// Read .js files
+		"allowJs": true,
+		// Generate d.ts files
+		"declaration": true,
+	  	// Only generate d.ts files
+	  	"emitDeclarationOnly": true,
+	}
+}