feat(types): Introduce @sentry/types package

packages/browser/package.json

@@ -16,7 +16,8 @@
   },
   "dependencies": {
     "@sentry/core": "0.5.4",
-    "@sentry/shim": "0.5.4"
+    "@sentry/shim": "0.5.4",
+    "@sentry/types": "0.5.4"
   },
   "devDependencies": {
     "chai": "^4.1.2",

packages/browser/src/backend.ts

@@ -1,10 +1,6 @@
 import { Backend, Options, SentryError } from '@sentry/core';
-import {
-  addBreadcrumb,
-  captureEvent,
-  SentryEvent,
-  SentryException,
-} from '@sentry/shim';
+import { addBreadcrumb, captureEvent } from '@sentry/shim';
+import { SentryEvent, SentryException } from '@sentry/types';
 import { Raven, SendMethod } from './raven';
 
 /** Original raven send function. */

packages/browser/src/client.ts

@@ -1,5 +1,5 @@
 import { BaseClient } from '@sentry/core';
-import { SdkInfo } from '@sentry/shim';
+import { SdkInfo } from '@sentry/types';
 import { BrowserBackend, BrowserOptions } from './backend';
 import { Raven } from './raven';
 

packages/browser/src/index.ts

@@ -10,7 +10,7 @@ export {
   Stacktrace,
   Thread,
   User,
-} from '@sentry/shim';
+} from '@sentry/types';
 
 export {
   addBreadcrumb,

packages/browser/src/raven.ts

@@ -1,4 +1,4 @@
-import { Breadcrumb, SentryEvent } from '@sentry/shim';
+import { Breadcrumb, SentryEvent } from '@sentry/types';
 // tslint:disable-next-line:no-implicit-dependencies
 import * as RavenJS from 'raven-js';
 

packages/core/package.json

@@ -15,7 +15,8 @@
     "access": "public"
   },
   "dependencies": {
-    "@sentry/shim": "0.5.4"
+    "@sentry/shim": "0.5.4",
+    "@sentry/types": "0.5.4"
   },
   "devDependencies": {
     "chai": "^4.1.2",

packages/core/src/base.ts

@@ -1,4 +1,4 @@
-import { Breadcrumb, Context, SdkInfo, SentryEvent } from '@sentry/shim';
+import { Breadcrumb, Context, SdkInfo, SentryEvent } from '@sentry/types';
 import { DSN } from './dsn';
 import { Backend, Client, Options, Scope } from './interfaces';
 import { SendStatus } from './status';

packages/core/src/interfaces.ts

@@ -1,4 +1,4 @@
-import { Breadcrumb, Context, SentryEvent } from '@sentry/shim';
+import { Breadcrumb, Context, SentryEvent } from '@sentry/types';
 import { DSN } from './dsn';
 import { SendStatus } from './status';
 

packages/core/src/sdk.ts

@@ -1,4 +1,7 @@
-import * as Shim from '@sentry/shim';
+import {
+  bindClient as shimBindClient,
+  getCurrentClient as shimGetCurrentClient,
+} from '@sentry/shim';
 import { Client, Options } from './interfaces';
 
 export {
@@ -28,11 +31,11 @@ export function initAndBind<F extends Client, O extends Options>(
   clientClass: ClientClass<F, O>,
   options: O,
 ): void {
-  if (Shim.getCurrentClient()) {
+  if (shimGetCurrentClient()) {
     return;
   }
 
   const client = new clientClass(options);
   client.install();
-  Shim.bindClient(client);
+  shimBindClient(client);
 }

packages/node/package.json

@@ -17,6 +17,7 @@
   "dependencies": {
     "@sentry/core": "0.5.4",
     "@sentry/shim": "0.5.4",
+    "@sentry/types": "0.5.4",
     "raven": "^2.6.0"
   },
   "devDependencies": {

packages/node/src/backend.ts

@@ -1,5 +1,6 @@
 import { Backend, DSN, Options, SentryError } from '@sentry/core';
-import { addBreadcrumb, captureEvent, SentryEvent } from '@sentry/shim';
+import { addBreadcrumb, captureEvent } from '@sentry/shim';
+import { SentryEvent } from '@sentry/types';
 import {
   HTTPSTransport,
   HTTPTransport,

packages/node/src/client.ts

@@ -1,5 +1,5 @@
 import { BaseClient } from '@sentry/core';
-import { SdkInfo } from '@sentry/shim';
+import { SdkInfo } from '@sentry/types';
 import { NodeBackend, NodeOptions } from './backend';
 import { Raven } from './raven';
 

packages/node/src/index.ts

@@ -10,7 +10,7 @@ export {
   Stacktrace,
   Thread,
   User,
-} from '@sentry/shim';
+} from '@sentry/types';
 
 export {
   addBreadcrumb,

packages/node/src/raven.ts

@@ -1,4 +1,4 @@
-import { Breadcrumb, SentryEvent } from '@sentry/shim';
+import { Breadcrumb, SentryEvent } from '@sentry/types';
 import * as RavenNode from 'raven';
 
 export type SendMethod = (event: SentryEvent, cb?: (err: any) => void) => void;

packages/shim/package.json

@@ -14,6 +14,9 @@
   "publishConfig": {
     "access": "public"
   },
+  "dependencies": {
+    "@sentry/types": "0.5.4"
+  },
   "devDependencies": {
     "chai": "^4.1.2",
     "jest": "^22.4.3",

packages/shim/src/index.ts

@@ -10,7 +10,7 @@ export {
   Stacktrace,
   Thread,
   User,
-} from './models';
+} from '@sentry/types';
 export {
   _callOnClient,
   addBreadcrumb,

packages/shim/src/sdk.ts

@@ -1,5 +1,5 @@
+import { Breadcrumb, SentryEvent, User } from '@sentry/types';
 import { getGlobalRegistry } from './global';
-import { Breadcrumb, SentryEvent, User } from './models';
 import { API_VERSION, Shim } from './shim';
 
 /** Default callback used for catching async errors. */

packages/types/.npmignore

@@ -0,0 +1,2 @@
+*
+!/dist/**/*

packages/types/LICENSE

@@ -0,0 +1,27 @@
+Copyright (c) 2018 Sentry (https://sentry.io) and individual contributors.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+    1. Redistributions of source code must retain the above copyright notice,
+this list of conditions and the following disclaimer.
+
+    2. Redistributions in binary form must reproduce the above copyright
+notice, this list of conditions and the following disclaimer in the
+documentation and/or other materials provided with the distribution.
+
+    3. Neither the name of the Sentry nor the names of its contributors may be
+used to endorse or promote products derived from this software without specific
+prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

packages/types/README.md

@@ -0,0 +1,14 @@
+<p align="center">
+  <a href="https://sentry.io" target="_blank" align="center">
+    <img src="https://sentry-brand.storage.googleapis.com/sentry-logo-black.png" width="280">
+  </a>
+  <br />
+</p>
+
+# Sentry JavaScript SDK Types
+
+[![npm version](https://img.shields.io/npm/v/@sentry/types.svg)](https://www.npmjs.com/package/@sentry/types)
+[![npm dm](https://img.shields.io/npm/dm/@sentry/types.svg)](https://www.npmjs.com/package/@sentry/types)
+[![npm dt](https://img.shields.io/npm/dt/@sentry/types.svg)](https://www.npmjs.com/package/@sentry/types)
+
+Common types used by the Sentry JavaScript SDKs.

packages/types/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@sentry/types",
+  "version": "0.5.4",
+  "description": "Types for all Sentry JavaScript SDKs",
+  "repository": "git://github.com/getsentry/raven-js.git",
+  "homepage": "https://github.com/getsentry/raven-js/tree/next/packages/types",
+  "author": "Sentry",
+  "license": "BSD-3-Clause",
+  "engines": {
+    "node": ">=6"
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "npm-run-all": "^4.1.2",
+    "prettier": "^1.12.1",
+    "prettier-check": "^2.0.0",
+    "tslint": "^5.9.1",
+    "typescript": "^2.8.3"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "lint": "run-s lint:prettier lint:tslint",
+    "lint:prettier": "prettier-check '{src,test}/**/*.ts'",
+    "lint:tslint": "tslint -t stylish -p .",
+    "fix": "run-s fix:tslint fix:prettier",
+    "fix:prettier": "prettier --write '{src,test}/**/*.ts'",
+    "fix:tslint": "tslint --fix -t stylish -p ."
+  }
+}

packages/types/tsconfig.build.json

@@ -0,0 +1,9 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "baseUrl": ".",
+    "outDir": "dist",
+    "rootDir": "src"
+  },
+  "include": ["src/**/*.ts"]
+}

packages/types/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "extends": "./tsconfig.build.json",
+  "include": ["src/**/*.ts"],
+  "exclude": ["dist"],
+  "compilerOptions": {
+    "rootDir": ".",
+    "types": ["node"],
+    "plugins": [{ "name": "tslint-language-service" }]
+  }
+}

packages/types/tslint.json

@@ -0,0 +1,3 @@
+{
+  "extends": "@sentry/typescript/tslint"
+}

packages/utils/package.json

@@ -14,6 +14,9 @@
   "publishConfig": {
     "access": "public"
   },
+  "dependencies": {
+    "@sentry/types": "0.5.4"
+  },
   "devDependencies": {
     "chai": "^4.1.2",
     "jest": "^22.4.3",