@sentry/types

What is @sentry/types?

The @sentry/types package provides TypeScript definitions for Sentry's JavaScript SDK. It includes types for Sentry's configuration options, event objects, and various interfaces used within Sentry's SDKs. This package is primarily used by developers to ensure type safety and autocompletion when working with Sentry in a TypeScript environment.

What are @sentry/types's main functionalities?

Event Interface

Defines the structure of an event that can be sent to Sentry. This includes the event's ID, level, timestamp, platform, and SDK information.

{
  event_id: string;
  level: 'error' | 'warning' | 'info' | 'debug';
  timestamp: number;
  platform: string;
  sdk: {
    name: string;
    version: string;
  };
}

Options Interface

Specifies the options for configuring the Sentry SDK. This includes the DSN (Data Source Name), breadcrumb limits, debug mode, integrations, and a beforeSend hook for event manipulation.

{
  dsn: string;
  maxBreadcrumbs: number;
  debug: boolean;
  integrations: Integration[];
  beforeSend: (event: Event) => Event | null;
}

Breadcrumb Interface

Describes a breadcrumb, which is a snapshot of data that describes what happened before an event. This includes the timestamp, message, category, level, and any additional data.

{
  timestamp: number;
  message: string;
  category: string;
  level: 'critical' | 'error' | 'warning' | 'info' | 'debug';
  data: Record<string, any>;
}

Other packages similar to @sentry/types

@types/node

Provides TypeScript definitions for Node.js. Similar to @sentry/types, it's used for type safety and autocompletion but focuses on Node.js' API rather than Sentry's.

typescript

The TypeScript language itself, which includes its compiler and type system. While not a direct alternative, it's the foundation that packages like @sentry/types build upon to provide type definitions for specific libraries.

@types/react

Offers TypeScript definitions for React. Similar to @sentry/types, it aids in developing React applications with TypeScript by providing types for React's API, but it doesn't relate to error monitoring or logging.

README

Sentry JavaScript SDK Types (DEPRECATED)

DEPRECATION NOTICE: The @sentry/types package is deprecated. All exports have been moved to @sentry/core. Import everything from @sentry/core instead.

Links

• Official SDK Docs

General

Common types used by the Sentry JavaScript SDKs.

Changelog

9.40.0

Important Changes

• feat(browser): Add debugId sync APIs between web worker and main thread (#16981)

This release adds two Browser SDK APIs to let the main thread know about debugIds of worker files:

• webWorkerIntegration({worker}) to be used in the main thread
• registerWebWorker({self}) to be used in the web worker

// main.js
Sentry.init({...})

const worker = new MyWorker(...);

Sentry.addIntegration(Sentry.webWorkerIntegration({ worker }));

worker.addEventListener('message', e => {...});

// worker.js
Sentry.registerWebWorker({ self });

self.postMessage(...);

• feat(core): Deprecate logger in favor of debug (#17040)

The internal SDK logger export from @sentry/core has been deprecated in favor of the debug export. debug only exposes log, warn, and error methods but is otherwise identical to logger. Note that this deprecation does not affect the logger export from other packages (like @sentry/browser or @sentry/node) which is used for Sentry Logging.

import { logger, debug } from '@sentry/core';

// before
logger.info('This is an info message');

// after
debug.log('This is an info message');

• feat(node): Add OpenAI integration (#17022)

This release adds official support for instrumenting OpenAI SDK calls in with Sentry tracing, following OpenTelemetry semantic conventions for Generative AI. It instruments:

• client.chat.completions.create() - For chat-based completions
• client.responses.create() - For the responses API

// The integration respects your `sendDefaultPii` option, but you can override the behavior in the integration options

Sentry.init({
  dsn: '__DSN__',
  integrations: [
    Sentry.openAIIntegration({
      recordInputs: true, // Force recording prompts
      recordOutputs: true, // Force recording responses
    }),
  ],
});

Other Changes

• feat(node-core): Expand @opentelemetry/instrumentation range to cover 0.203.0 (#17043)
• fix(cloudflare): Ensure errors get captured from durable objects (#16838)
• fix(sveltekit): Ensure server errors from streamed responses are sent (#17044)

Work in this release was contributed by @0xbad0c0d3 and @tommy-gilligan. Thank you for your contributions!