Update type definitions for breadcrumbs (#963)

* Add breadcrumb and loglevel typings.
* add auto breadcrumb options definitions.
* Add comment for autobreadcrumb options
* Add test for auto breadcrumbs
* Change from BreadCrumb to Breadcrumb spelling for consistency

Author: tomasklingen

typescript/raven-tests.ts

@@ -19,7 +19,13 @@ var options = {
     whitelistUrls: [
         /https?:\/\/google\.com/,
         'https://www.google.com'
-    ]
+    ],
+    autoBreadcrumbs: {
+        xhr: false,
+        console: false,
+        dom: true,
+        location: false
+    }
 };
 
 Raven.config('https://public@sentry.io/1', options).install();
@@ -55,7 +61,9 @@ var err:Error = Raven.lastException();
 Raven.captureMessage('Broken!');
 Raven.captureMessage('Broken!', {tags: { key: "value" }});
 +Raven.captureMessage('Broken!', { stacktrace: true });
-Raven.captureBreadcrumb({});
+Raven.captureBreadcrumb({
+    message: "This is a breadcrumb message."
+});
 
 Raven.setRelease('abc123');
 Raven.setEnvironment('production');

typescript/raven.d.ts

@@ -8,7 +8,7 @@ export = Raven;
 
 interface RavenOptions {
     /** The log level associated with this event. Default: error */
-    level?: string;
+    level?: LogLevel;
 
     /** The name of the logger used by Sentry. Default: javascript */
     logger?: string;
@@ -64,6 +64,9 @@ interface RavenOptions {
 
     /** Enables/disables instrumentation of globals. */
     instrument?: boolean | RavenInstrumentationOptions;
+
+    /** Enables/disables automatic collection of breadcrumbs. */
+    autoBreadcrumbs?: boolean | AutoBreadcrumbOptions
 }
 
 interface RavenInstrumentationOptions {
@@ -168,7 +171,7 @@ interface RavenStatic {
     captureMessage(msg: string, options?: RavenOptions): RavenStatic;
 
     /** Log a breadcrumb */
-    captureBreadcrumb(crumb: Object): RavenStatic;
+    captureBreadcrumb(crumb: Breadcrumb): RavenStatic;
 
     /**
      * Clear the user context, removing the user data that would be sent to Sentry.
@@ -245,3 +248,22 @@ interface RavenTransportOptions {
 interface RavenPlugin {
     (raven: RavenStatic, ...args: any[]): RavenStatic;
 }
+
+interface Breadcrumb {
+    message?: string;
+    category?: string;
+    level?: LogLevel;
+    data?: any;
+    type?: BreadcrumbType
+}
+
+type BreadcrumbType = "navigation" | "http";
+
+interface AutoBreadcrumbOptions {
+    xhr?: boolean;
+    console?: boolean;
+    dom?: boolean;
+    location?: boolean;
+}
+
+type LogLevel = "critical" | "error" | "warn" | "info" | "debug";