@sentry/types - npm Package Compare versions

Comparing version 4.0.0-beta.12 to 4.0.0-rc.0

dist/index.d.ts

@@ -1,7 +0,7 @@
-/** Supported Sentry transport protocols in a DSN. */
-export declare type DSNProtocol = 'http' | 'https';
-/** Primitive components of a DSN. */
-export interface DSNComponents {
+/** Supported Sentry transport protocols in a Dsn. */
+export declare type DsnProtocol = 'http' | 'https';
+/** Primitive components of a Dsn. */
+export interface DsnComponents {
     /** Protocol used to connect to Sentry. */
-    protocol: DSNProtocol;
+    protocol: DsnProtocol;
     /** Public authorization key. */
@@ -20,22 +20,31 @@ user: string;
 }
-/** Anything that can be parsed into a DSN. */
-export declare type DSNLike = string | DSNComponents;
-/** TODO */
+/** Anything that can be parsed into a Dsn. */
+export declare type DsnLike = string | DsnComponents;
+/** JSDoc */
 export declare enum Severity {
-    /** TODO */
+    /** JSDoc */
     Fatal = "fatal",
-    /** TODO */
+    /** JSDoc */
     Error = "error",
-    /** TODO */
+    /** JSDoc */
     Warning = "warning",
-    /** TODO */
+    /** JSDoc */
     Log = "log",
-    /** TODO */
+    /** JSDoc */
     Info = "info",
-    /** TODO */
+    /** JSDoc */
     Debug = "debug",
-    /** TODO */
+    /** JSDoc */
     Critical = "critical"
 }
-/** TODO */
+export declare namespace Severity {
+    /**
+     * Converts a string-based level into a {@link Severity}.
+     *
+     * @param level string representation of Severity
+     * @returns Severity
+     */
+    function fromString(level: string): Severity;
+}
+/** JSDoc */
 export interface Breadcrumb {
@@ -50,3 +59,3 @@ type?: string;
 }
-/** TODO */
+/** JSDoc */
 export interface User {
@@ -61,3 +70,3 @@ id?: string;
 }
-/** TODO */
+/** JSDoc */
 export interface SdkInfo {
@@ -69,3 +78,3 @@ name: string;
 }
-/** TODO */
+/** JSDoc */
 export interface Package {
@@ -75,3 +84,3 @@ name: string;
 }
-/** TODO */
+/** JSDoc */
 export interface StackFrame {
@@ -93,3 +102,3 @@ filename?: string;
 }
-/** TODO */
+/** JSDoc */
 export interface Stacktrace {
@@ -99,3 +108,3 @@ frames?: StackFrame[];
 }
-/** TODO */
+/** JSDoc */
 export interface Thread {
@@ -108,3 +117,3 @@ id?: number;
 }
-/** TODO */
+/** JSDoc */
 export interface SentryException {
@@ -117,3 +126,3 @@ type?: string;
 }
-/** TODO */
+/** JSDoc */
 export interface Request {
@@ -134,3 +143,9 @@ url?: string;
 }
-/** TODO */
+/** JSDoc */
+export interface Repo {
+    name: string;
+    prefix?: string;
+    revision?: string;
+}
+/** JSDoc */
 export interface SentryEvent {
@@ -143,4 +158,5 @@ event_id?: string;
     logger?: string;
-    server?: string;
+    server_name?: string;
     release?: string;
+    repos?: Repo[];
     dist?: string;
@@ -156,3 +172,4 @@ environment?: string;
     exception?: {
-        values: SentryException[];
+        values?: SentryException[];
+        mechanism?: Mechanism;
     };
@@ -172,23 +189,32 @@ stacktrace?: Stacktrace;
 }
-/** TODO */
+/** JSDoc */
+export interface Mechanism {
+    type: string;
+    handled: boolean;
+    data?: {
+        [key: string]: string;
+    };
+}
+/** JSDoc */
 export interface Integration {
     name: string;
-    handler?: any;
-    install(): void;
+    install(options?: object): void;
 }
-/** TODO */
+/** JSDoc */
 export interface SentryResponse {
     status: Status;
+    event?: SentryEvent;
+    reason?: string;
 }
-/** TODO */
+/** JSDoc */
 export interface TransportOptions {
-    dsn: DSNLike;
+    dsn: DsnLike;
     /** Define custom headers */
     headers?: object;
 }
-/** TODO */
+/** JSDoc */
 export interface Transport {
-    send(event: SentryEvent): Promise<SentryResponse>;
+    captureEvent(event: SentryEvent): Promise<SentryResponse>;
 }
-/** TODO */
+/** JSDoc */
 export interface TransportClass<T extends Transport> {
@@ -221,1 +247,19 @@ new (options: TransportOptions): T;
 }
+/** JSDoc */
+export interface SentryWrappedFunction extends Function {
+    [key: string]: any;
+    __sentry__?: boolean;
+    __sentry_wrapper__?: SentryWrappedFunction;
+    __sentry_original__?: SentryWrappedFunction;
+}
+/** JSDoc */
+export interface SentryEventHint {
+    event_id?: string;
+    syntheticException?: Error | null;
+    originalException?: Error | null;
+    data?: any;
+}
+/** JSDoc */
+export interface SentryBreadcrumbHint {
+    [key: string]: any;
+}

dist/index.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-/** TODO */
+/** JSDoc */
 var Severity;
 (function (Severity) {
-    /** TODO */
+    /** JSDoc */
     Severity["Fatal"] = "fatal";
-    /** TODO */
+    /** JSDoc */
     Severity["Error"] = "error";
-    /** TODO */
+    /** JSDoc */
     Severity["Warning"] = "warning";
-    /** TODO */
+    /** JSDoc */
     Severity["Log"] = "log";
-    /** TODO */
+    /** JSDoc */
     Severity["Info"] = "info";
-    /** TODO */
+    /** JSDoc */
     Severity["Debug"] = "debug";
-    /** TODO */
+    /** JSDoc */
     Severity["Critical"] = "critical";
 })(Severity = exports.Severity || (exports.Severity = {}));
+// tslint:disable:no-unnecessary-qualifier no-namespace
+(function (Severity) {
+    /**
+     * Converts a string-based level into a {@link Severity}.
+     *
+     * @param level string representation of Severity
+     * @returns Severity
+     */
+    function fromString(level) {
+        switch (level) {
+            case 'debug':
+                return Severity.Debug;
+            case 'info':
+                return Severity.Info;
+            case 'warn':
+            case 'warning':
+                return Severity.Warning;
+            case 'error':
+                return Severity.Error;
+            case 'fatal':
+                return Severity.Fatal;
+            case 'critical':
+                return Severity.Critical;
+            case 'log':
+            default:
+                return Severity.Log;
+        }
+    }
+    Severity.fromString = fromString;
+})(Severity = exports.Severity || (exports.Severity = {}));
 /** The status of an event. */
@@ -22,0 +52,0 @@ var Status;

package.json

 {
   "name": "@sentry/types",
-  "version": "4.0.0-beta.12",
+  "version": "4.0.0-rc.0",
   "description": "Types for all Sentry JavaScript SDKs",
@@ -19,6 +19,6 @@ "repository": "git://github.com/getsentry/raven-js.git",
     "npm-run-all": "^4.1.2",
-    "prettier": "^1.12.1",
+    "prettier": "^1.14.0",
     "prettier-check": "^2.0.0",
-    "tslint": "^5.9.1",
-    "typescript": "^2.8.3"
+    "tslint": "^5.11.0",
+    "typescript": "^3.0.1"
   },
@@ -25,0 +25,0 @@ "scripts": {

No alert changes

Improved metrics

Total package byte prevSize

20108

25.95%

Lines of code

342

27.61%

No dependency changes