@sentry/types - npm Package Compare versions

Comparing version 8.0.0-alpha.9 to 8.0.0-beta.1

package.json

 {
   "name": "@sentry/types",
-  "version": "8.0.0-alpha.9",
+  "version": "8.0.0-beta.1",
   "description": "Types for all Sentry JavaScript SDKs",
@@ -5,0 +5,0 @@ "repository": "git://github.com/getsentry/sentry-javascript.git",

types-ts3.8/breadcrumb.d.ts

 import { SeverityLevel } from './severity';
-/** JSDoc */
+/**
+ * Sentry uses breadcrumbs to create a trail of events that happened prior to an issue.
+ * These events are very similar to traditional logs but can record more rich structured data.
+ *
+ * @link https://develop.sentry.dev/sdk/event-payloads/breadcrumbs/
+ */
 export interface Breadcrumb {
+    /**
+     * By default, all breadcrumbs are recorded as default, which makes them appear as a Debug entry, but Sentry provides
+     * other types that influence how the breadcrumbs are rendered. For more information, see the description of
+     * recognized breadcrumb types.
+     *
+     * @summary The type of breadcrumb.
+     * @link https://develop.sentry.dev/sdk/event-payloads/breadcrumbs/#breadcrumb-types
+     */
     type?: string;
+    /**
+     * Allowed values are, from highest to lowest:
+     * `fatal`, `error`, `warning`, `info`, and `debug`.
+     * Levels are used in the UI to emphasize and deemphasize the crumb. The default is `info`.
+     *
+     * @summary This defines the severity level of the breadcrumb.
+     */
     level?: SeverityLevel;
     event_id?: string;
+    /**
+     * Typically it is a module name or a descriptive string. For instance, `ui.click` could be used to
+     * indicate that a click happened in the UI or flask could be used to indicate that the event originated in
+     * the Flask framework.
+     * @private Internally we render some crumbs' color and icon based on the provided category.
+     *          For more information, see the description of recognized breadcrumb types.
+     * @summary A dotted string indicating what the crumb is or from where it comes.
+     * @link    https://develop.sentry.dev/sdk/event-payloads/breadcrumbs/#breadcrumb-types
+     */
     category?: string;
+    /**
+     * If a message is provided, it is rendered as text with all whitespace preserved.
+     *
+     * @summary Human-readable message for the breadcrumb.
+     */
     message?: string;
+    /**
+     * Contains a dictionary whose contents depend on the breadcrumb type.
+     * Additional parameters that are unsupported by the type are rendered as a key/value table.
+     *
+     * @summary Arbitrary data associated with this breadcrumb.
+     */
     data?: {
         [key: string]: any;
     };
+    /**
+     * The format is a numeric (integer or float) value representing
+     * the number of seconds that have elapsed since the Unixepoch.
+     * Breadcrumbs are most useful when they include a timestamp, as it creates a timeline
+     * leading up to an event expection/error.
+     *
+     * @note The API supports a string as defined in RFC 3339, but the SDKs only support a numeric value for now.
+     *
+     * @summary A timestamp representing when the breadcrumb occurred.
+     * @link https://develop.sentry.dev/sdk/event-payloads/breadcrumbs/#:~:text=is%20info.-,timestamp,-(recommended)
+     */
     timestamp?: number;
@@ -13,0 +64,0 @@ }

types-ts3.8/datacategory.d.ts

@@ -1,2 +0,2 @@
-export type DataCategory = 'default' | 'error' | 'transaction' | 'replay' | 'security' | 'attachment' | 'session' | 'internal' | 'profile' | 'monitor' | 'feedback' | 'statsd' | 'unknown';
+export type DataCategory = 'default' | 'error' | 'transaction' | 'replay' | 'security' | 'attachment' | 'session' | 'internal' | 'profile' | 'monitor' | 'feedback' | 'metric_bucket' | 'span' | 'unknown';
 //# sourceMappingURL=datacategory.d.ts.map

types-ts3.8/envelope.d.ts

@@ -11,2 +11,3 @@ import { AttachmentType } from './attachment';
 import { SerializedSession, Session, SessionAggregates } from './session';
+import { Span } from './span';
 export type DynamicSamplingContext = {
@@ -22,3 +23,3 @@ trace_id: string;
 };
-export type EnvelopeItemType = 'client_report' | 'user_report' | 'feedback' | 'session' | 'sessions' | 'transaction' | 'attachment' | 'event' | 'profile' | 'replay_event' | 'replay_recording' | 'check_in' | 'statsd';
+export type EnvelopeItemType = 'client_report' | 'user_report' | 'feedback' | 'session' | 'sessions' | 'transaction' | 'attachment' | 'event' | 'profile' | 'replay_event' | 'replay_recording' | 'check_in' | 'statsd' | 'span';
 export type BaseEnvelopeHeaders = {
@@ -84,2 +85,5 @@ [key: string]: unknown;
 };
+type SpanItemHeaders = {
+    type: 'span';
+};
 export type EventItem = BaseEnvelopeItem<EventItemHeaders, Event>;
@@ -96,2 +100,3 @@ export type AttachmentItem = BaseEnvelopeItem<AttachmentItemHeaders, string | Uint8Array>;
 export type ProfileItem = BaseEnvelopeItem<ProfileItemHeaders, Profile>;
+export type SpanItem = BaseEnvelopeItem<SpanItemHeaders, Span>;
 export type EventEnvelopeHeaders = {
@@ -111,2 +116,3 @@ event_id: string;
 type StatsdEnvelopeHeaders = BaseEnvelopeHeaders;
+type SpanEnvelopeHeaders = BaseEnvelopeHeaders;
 export type EventEnvelope = BaseEnvelope<EventEnvelopeHeaders, EventItem | AttachmentItem | UserFeedbackItem | FeedbackItem | ProfileItem>;
@@ -124,5 +130,6 @@ export type SessionEnvelope = BaseEnvelope<SessionEnvelopeHeaders, SessionItem>;
 export type StatsdEnvelope = BaseEnvelope<StatsdEnvelopeHeaders, StatsdItem>;
-export type Envelope = EventEnvelope | SessionEnvelope | ClientReportEnvelope | ReplayEnvelope | CheckInEnvelope | StatsdEnvelope;
+export type SpanEnvelope = BaseEnvelope<SpanEnvelopeHeaders, SpanItem>;
+export type Envelope = EventEnvelope | SessionEnvelope | ClientReportEnvelope | ReplayEnvelope | CheckInEnvelope | StatsdEnvelope | SpanEnvelope;
 export type EnvelopeItem = Envelope[1][number];
 export {};
 //# sourceMappingURL=envelope.d.ts.map

types-ts3.8/hub.d.ts

@@ -14,2 +14,9 @@ import { Breadcrumb, BreadcrumbHint } from './breadcrumb';
  * working in case we have a version conflict.
+ *
+ * @deprecated This interface will be removed in a future major version of the SDK in favour of
+ * `Scope` and `Client` objects and APIs.
+ *
+ * Most APIs referencing `Hub` are themselves and will be removed in version 8 of the SDK. More information:
+ * - [Migration Guide](https://github.com/getsentry/sentry-javascript/blob/develop/MIGRATION.md#deprecate-hub)
+ *
  */
@@ -16,0 +23,0 @@ export interface Hub {

types-ts3.8/index.d.ts

@@ -9,3 +9,3 @@ export { Attachment } from './attachment';
 export { DebugImage, DebugMeta } from './debugMeta';
-export { AttachmentItem, BaseEnvelopeHeaders, BaseEnvelopeItemHeaders, ClientReportEnvelope, ClientReportItem, DynamicSamplingContext, Envelope, EnvelopeItemType, EnvelopeItem, EventEnvelope, EventEnvelopeHeaders, EventItem, ReplayEnvelope, FeedbackItem, SessionEnvelope, SessionItem, UserFeedbackItem, CheckInItem, CheckInEnvelope, StatsdItem, StatsdEnvelope, ProfileItem, } from './envelope';
+export { AttachmentItem, BaseEnvelopeHeaders, BaseEnvelopeItemHeaders, ClientReportEnvelope, ClientReportItem, DynamicSamplingContext, Envelope, EnvelopeItemType, EnvelopeItem, EventEnvelope, EventEnvelopeHeaders, EventItem, ReplayEnvelope, FeedbackItem, SessionEnvelope, SessionItem, UserFeedbackItem, CheckInItem, CheckInEnvelope, StatsdItem, StatsdEnvelope, ProfileItem, SpanEnvelope, SpanItem, } from './envelope';
 export { ExtendedError } from './error';
@@ -25,3 +25,3 @@ export { Event, EventHint, EventType, ErrorEvent, TransactionEvent } from './event';
 export { ReplayEvent, ReplayRecordingData, ReplayRecordingMode } from './replay';
-export { FeedbackEvent, UserFeedback } from './feedback';
+export { FeedbackDialog, FeedbackEvent, FeedbackFormData, FeedbackInternalOptions, FeedbackModalIntegration, FeedbackScreenshotIntegration, SendFeedback, SendFeedbackParams, CreateDialogProps, UserFeedback, } from './feedback';
 export { QueryParams, Request, SanitizedRequestData } from './request';
@@ -28,0 +28,0 @@ export { Runtime } from './runtime';

types-ts3.8/options.d.ts

@@ -82,2 +82,14 @@ import { Breadcrumb, BreadcrumbHint } from './breadcrumb';
     /**
+     * If this is enabled, any spans started will always have their parent be the active root span,
+     * if there is any active span.
+     *
+     * This is necessary because in some environments (e.g. browser),
+     * we cannot guarantee an accurate active span.
+     * Because we cannot properly isolate execution environments,
+     * you may get wrong results when using e.g. nested `startSpan()` calls.
+     *
+     * To solve this, in these environments we'll by default enable this option.
+     */
+    parentSpanIsAlwaysRootSpan?: boolean;
+    /**
      * Initial data to populate scope.
@@ -84,0 +96,0 @@ */

types/breadcrumb.d.ts

 import type { SeverityLevel } from './severity';
-/** JSDoc */
+/**
+ * Sentry uses breadcrumbs to create a trail of events that happened prior to an issue.
+ * These events are very similar to traditional logs but can record more rich structured data.
+ *
+ * @link https://develop.sentry.dev/sdk/event-payloads/breadcrumbs/
+ */
 export interface Breadcrumb {
+    /**
+     * By default, all breadcrumbs are recorded as default, which makes them appear as a Debug entry, but Sentry provides
+     * other types that influence how the breadcrumbs are rendered. For more information, see the description of
+     * recognized breadcrumb types.
+     *
+     * @summary The type of breadcrumb.
+     * @link https://develop.sentry.dev/sdk/event-payloads/breadcrumbs/#breadcrumb-types
+     */
     type?: string;
+    /**
+     * Allowed values are, from highest to lowest:
+     * `fatal`, `error`, `warning`, `info`, and `debug`.
+     * Levels are used in the UI to emphasize and deemphasize the crumb. The default is `info`.
+     *
+     * @summary This defines the severity level of the breadcrumb.
+     */
     level?: SeverityLevel;
     event_id?: string;
+    /**
+     * Typically it is a module name or a descriptive string. For instance, `ui.click` could be used to
+     * indicate that a click happened in the UI or flask could be used to indicate that the event originated in
+     * the Flask framework.
+     * @private Internally we render some crumbs' color and icon based on the provided category.
+     *          For more information, see the description of recognized breadcrumb types.
+     * @summary A dotted string indicating what the crumb is or from where it comes.
+     * @link    https://develop.sentry.dev/sdk/event-payloads/breadcrumbs/#breadcrumb-types
+     */
     category?: string;
+    /**
+     * If a message is provided, it is rendered as text with all whitespace preserved.
+     *
+     * @summary Human-readable message for the breadcrumb.
+     */
     message?: string;
+    /**
+     * Contains a dictionary whose contents depend on the breadcrumb type.
+     * Additional parameters that are unsupported by the type are rendered as a key/value table.
+     *
+     * @summary Arbitrary data associated with this breadcrumb.
+     */
     data?: {
         [key: string]: any;
     };
+    /**
+     * The format is a numeric (integer or float) value representing
+     * the number of seconds that have elapsed since the Unixepoch.
+     * Breadcrumbs are most useful when they include a timestamp, as it creates a timeline
+     * leading up to an event expection/error.
+     *
+     * @note The API supports a string as defined in RFC 3339, but the SDKs only support a numeric value for now.
+     *
+     * @summary A timestamp representing when the breadcrumb occurred.
+     * @link https://develop.sentry.dev/sdk/event-payloads/breadcrumbs/#:~:text=is%20info.-,timestamp,-(recommended)
+     */
     timestamp?: number;
@@ -13,0 +64,0 @@ }

types/datacategory.d.ts

@@ -1,2 +0,2 @@
-export type DataCategory = 'default' | 'error' | 'transaction' | 'replay' | 'security' | 'attachment' | 'session' | 'internal' | 'profile' | 'monitor' | 'feedback' | 'statsd' | 'unknown';
+export type DataCategory = 'default' | 'error' | 'transaction' | 'replay' | 'security' | 'attachment' | 'session' | 'internal' | 'profile' | 'monitor' | 'feedback' | 'metric_bucket' | 'span' | 'unknown';
 //# sourceMappingURL=datacategory.d.ts.map

types/envelope.d.ts

@@ -11,2 +11,3 @@ import type { AttachmentType } from './attachment';
 import type { SerializedSession, Session, SessionAggregates } from './session';
+import type { Span } from './span';
 export type DynamicSamplingContext = {
@@ -22,3 +23,3 @@ trace_id: string;
 };
-export type EnvelopeItemType = 'client_report' | 'user_report' | 'feedback' | 'session' | 'sessions' | 'transaction' | 'attachment' | 'event' | 'profile' | 'replay_event' | 'replay_recording' | 'check_in' | 'statsd';
+export type EnvelopeItemType = 'client_report' | 'user_report' | 'feedback' | 'session' | 'sessions' | 'transaction' | 'attachment' | 'event' | 'profile' | 'replay_event' | 'replay_recording' | 'check_in' | 'statsd' | 'span';
 export type BaseEnvelopeHeaders = {
@@ -81,2 +82,5 @@ [key: string]: unknown;
 };
+type SpanItemHeaders = {
+    type: 'span';
+};
 export type EventItem = BaseEnvelopeItem<EventItemHeaders, Event>;
@@ -93,2 +97,3 @@ export type AttachmentItem = BaseEnvelopeItem<AttachmentItemHeaders, string | Uint8Array>;
 export type ProfileItem = BaseEnvelopeItem<ProfileItemHeaders, Profile>;
+export type SpanItem = BaseEnvelopeItem<SpanItemHeaders, Span>;
 export type EventEnvelopeHeaders = {
@@ -108,2 +113,3 @@ event_id: string;
 type StatsdEnvelopeHeaders = BaseEnvelopeHeaders;
+type SpanEnvelopeHeaders = BaseEnvelopeHeaders;
 export type EventEnvelope = BaseEnvelope<EventEnvelopeHeaders, EventItem | AttachmentItem | UserFeedbackItem | FeedbackItem | ProfileItem>;
@@ -115,5 +121,6 @@ export type SessionEnvelope = BaseEnvelope<SessionEnvelopeHeaders, SessionItem>;
 export type StatsdEnvelope = BaseEnvelope<StatsdEnvelopeHeaders, StatsdItem>;
-export type Envelope = EventEnvelope | SessionEnvelope | ClientReportEnvelope | ReplayEnvelope | CheckInEnvelope | StatsdEnvelope;
+export type SpanEnvelope = BaseEnvelope<SpanEnvelopeHeaders, SpanItem>;
+export type Envelope = EventEnvelope | SessionEnvelope | ClientReportEnvelope | ReplayEnvelope | CheckInEnvelope | StatsdEnvelope | SpanEnvelope;
 export type EnvelopeItem = Envelope[1][number];
 export {};
 //# sourceMappingURL=envelope.d.ts.map

types/hub.d.ts

@@ -14,2 +14,9 @@ import type { Breadcrumb, BreadcrumbHint } from './breadcrumb';
  * working in case we have a version conflict.
+ *
+ * @deprecated This interface will be removed in a future major version of the SDK in favour of
+ * `Scope` and `Client` objects and APIs.
+ *
+ * Most APIs referencing `Hub` are themselves and will be removed in version 8 of the SDK. More information:
+ * - [Migration Guide](https://github.com/getsentry/sentry-javascript/blob/develop/MIGRATION.md#deprecate-hub)
+ *
  */
@@ -16,0 +23,0 @@ export interface Hub {

types/index.d.ts

@@ -9,3 +9,3 @@ export type { Attachment } from './attachment';
 export type { DebugImage, DebugMeta } from './debugMeta';
-export type { AttachmentItem, BaseEnvelopeHeaders, BaseEnvelopeItemHeaders, ClientReportEnvelope, ClientReportItem, DynamicSamplingContext, Envelope, EnvelopeItemType, EnvelopeItem, EventEnvelope, EventEnvelopeHeaders, EventItem, ReplayEnvelope, FeedbackItem, SessionEnvelope, SessionItem, UserFeedbackItem, CheckInItem, CheckInEnvelope, StatsdItem, StatsdEnvelope, ProfileItem, } from './envelope';
+export type { AttachmentItem, BaseEnvelopeHeaders, BaseEnvelopeItemHeaders, ClientReportEnvelope, ClientReportItem, DynamicSamplingContext, Envelope, EnvelopeItemType, EnvelopeItem, EventEnvelope, EventEnvelopeHeaders, EventItem, ReplayEnvelope, FeedbackItem, SessionEnvelope, SessionItem, UserFeedbackItem, CheckInItem, CheckInEnvelope, StatsdItem, StatsdEnvelope, ProfileItem, SpanEnvelope, SpanItem, } from './envelope';
 export type { ExtendedError } from './error';
@@ -25,3 +25,3 @@ export type { Event, EventHint, EventType, ErrorEvent, TransactionEvent } from './event';
 export type { ReplayEvent, ReplayRecordingData, ReplayRecordingMode } from './replay';
-export type { FeedbackEvent, UserFeedback } from './feedback';
+export type { FeedbackDialog, FeedbackEvent, FeedbackFormData, FeedbackInternalOptions, FeedbackModalIntegration, FeedbackScreenshotIntegration, SendFeedback, SendFeedbackParams, CreateDialogProps, UserFeedback, } from './feedback';
 export type { QueryParams, Request, SanitizedRequestData } from './request';
@@ -28,0 +28,0 @@ export type { Runtime } from './runtime';

types/options.d.ts

@@ -82,2 +82,14 @@ import type { Breadcrumb, BreadcrumbHint } from './breadcrumb';
     /**
+     * If this is enabled, any spans started will always have their parent be the active root span,
+     * if there is any active span.
+     *
+     * This is necessary because in some environments (e.g. browser),
+     * we cannot guarantee an accurate active span.
+     * Because we cannot properly isolate execution environments,
+     * you may get wrong results when using e.g. nested `startSpan()` calls.
+     *
+     * To solve this, in these environments we'll by default enable this option.
+     */
+    parentSpanIsAlwaysRootSpan?: boolean;
+    /**
      * Initial data to populate scope.
@@ -84,0 +96,0 @@ */

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

305656

increased by12.06%

Number of package files

179

increased by7.19%

Lines of code

6384

increased by15.36%

No dependency changes