@sentry/types 8.0.0-alpha.1 → 8.0.0-alpha.3

package/types-ts3.8/index.d.ts

@@ -8,7 +8,7 @@ export { DsnComponents, DsnLike, DsnProtocol } from './dsn';
 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 { ExtendedError } from './error';
-export { Event, EventHint, EventType, ErrorEvent, TransactionEvent, SerializedEvent } from './event';
+export { Event, EventHint, EventType, ErrorEvent, TransactionEvent } from './event';
 export { EventProcessor } from './eventprocessor';
 export { Exception } from './exception';
 export { Extra, Extras } from './extra';
@@ -21,7 +21,7 @@ export { Package } from './package';
 export { PolymorphicEvent, PolymorphicRequest } from './polymorphics';
 export { ThreadId, FrameId, StackId, ThreadCpuSample, ThreadCpuStack, ThreadCpuFrame, ThreadCpuProfile, Profile, } from './profiling';
 export { ReplayEvent, ReplayRecordingData, ReplayRecordingMode } from './replay';
-export { FeedbackEvent } from './feedback';
+export { FeedbackEvent, UserFeedback } from './feedback';
 export { QueryParams, Request, SanitizedRequestData } from './request';
 export { Runtime } from './runtime';
 export { CaptureContext, Scope, ScopeContext, ScopeData } from './scope';
@@ -30,6 +30,7 @@ export { SdkMetadata } from './sdkmetadata';
 export { SessionAggregates, AggregationCounts, Session, SessionContext, SessionStatus, RequestSession, RequestSessionStatus, SessionFlusherLike, SerializedSession, } from './session';
 export { SeverityLevel } from './severity';
 export { Span, SpanContext, SpanOrigin, SpanAttributeValue, SpanAttributes, SpanTimeInput, SpanJSON, SpanContextData, TraceFlag, MetricSummary, } from './span';
+export { SpanStatus } from './spanStatus';
 export { StackFrame } from './stackframe';
 export { Stacktrace, StackParser, StackLineParser, StackLineParserFn } from './stacktrace';
 export { PropagationContext, TracePropagationTargets } from './tracing';
@@ -38,7 +39,7 @@ export { CustomSamplingContext, SamplingContext, TraceparentData, Transaction, T
 export { DurationUnit, InformationUnit, FractionUnit, MeasurementUnit, NoneUnit, Measurements, } from './measurement';
 export { Thread } from './thread';
 export { Transport, TransportRequest, TransportMakeRequestResponse, InternalBaseTransportOptions, BaseTransportOptions, TransportRequestExecutor, } from './transport';
-export { User, UserFeedback } from './user';
+export { User } from './user';
 export { WebFetchHeaders, WebFetchRequest } from './webfetchapi';
 export { WrappedFunction } from './wrappedfunction';
 export { HandlerDataFetch, HandlerDataXhr, HandlerDataDom, HandlerDataConsole, HandlerDataHistory, HandlerDataError, HandlerDataUnhandledRejection, ConsoleLevel, SentryXhrData, SentryWrappedXMLHttpRequest, } from './instrument';

package/types-ts3.8/scope.d.ts

@@ -43,7 +43,6 @@ export interface ScopeData {
     };
     fingerprint: string[];
     level?: SeverityLevel;
-    /** @deprecated This will be removed in v8. */
     transactionName?: string;
     span?: Span;
 }
@@ -61,6 +60,11 @@ export interface Scope {
      * It is generally recommended to use the global function `Sentry.getClient()` instead, unless you know what you are doing.
      */
     getClient<C extends Client>(): C | undefined;
+    /**
+     * Add internal on change listener. Used for sub SDKs that need to store the scope.
+     * @hidden
+     */
+    addScopeListener(callback: (scope: Scope) => void): void;
     /** Add new event processor that will be called during event processing. */
     addEventProcessor(callback: EventProcessor): this;
     /** Get the data of this scope, which is applied to an event during processing. */
@@ -113,8 +117,15 @@ export interface Scope {
      */
     setLevel(level: SeverityLevel): this;
     /**
-     * Sets the transaction name on the scope for future events.
-     * @deprecated Use extra or tags instead.
+     * Sets the transaction name on the scope so that the name of the transaction
+     * (e.g. taken server route or page location) is attached to future events.
+     *
+     * IMPORTANT: Calling this function does NOT change the name of the currently active
+     * span. If you want to change the name of the active span, use `span.updateName()`
+     * instead.
+     *
+     * By default, the SDK updates the scope's transaction name automatically on sensible
+     * occasions, such as a page navigation or when handling a new request on the server.
      */
     setTransactionName(name?: string): this;
     /**

package/types-ts3.8/span.d.ts

@@ -1,5 +1,6 @@
 import { Primitive } from './misc';
 import { HrTime } from './opentelemetry';
+import { SpanStatus } from './spanStatus';
 import { TransactionSource } from './transaction';
 type SpanOriginType = 'manual' | 'auto';
 type SpanOriginCategory = string;
@@ -33,9 +34,6 @@ export interface SpanJSON {
     span_id: string;
     start_timestamp: number;
     status?: string;
-    tags?: {
-        [key: string]: Primitive;
-    };
     timestamp?: number;
     trace_id: string;
     origin?: SpanOrigin;
@@ -44,6 +42,43 @@ export interface SpanJSON {
 type TraceFlagNone = 0;
 type TraceFlagSampled = 1;
 export type TraceFlag = TraceFlagNone | TraceFlagSampled;
+export interface TraceState {
+    /**
+     * Create a new TraceState which inherits from this TraceState and has the
+     * given key set.
+     * The new entry will always be added in the front of the list of states.
+     *
+     * @param key key of the TraceState entry.
+     * @param value value of the TraceState entry.
+     */
+    set(key: string, value: string): TraceState;
+    /**
+     * Return a new TraceState which inherits from this TraceState but does not
+     * contain the given key.
+     *
+     * @param key the key for the TraceState entry to be removed.
+     */
+    unset(key: string): TraceState;
+    /**
+     * Returns the value to which the specified key is mapped, or `undefined` if
+     * this map contains no mapping for the key.
+     *
+     * @param key with which the specified value is to be associated.
+     * @returns the value to which the specified key is mapped, or `undefined` if
+     *     this map contains no mapping for the key.
+     */
+    get(key: string): string | undefined;
+    /**
+     * Serializes the TraceState to a `list` as defined below. The `list` is a
+     * series of `list-members` separated by commas `,`, and a list-member is a
+     * key/value pair separated by an equals sign `=`. Spaces and horizontal tabs
+     * surrounding `list-members` are ignored. There can be a maximum of 32
+     * `list-members` in a `list`.
+     *
+     * @returns the serialized string.
+     */
+    serialize(): string;
+}
 export interface SpanContextData {
     /**
      * The ID of the trace that this span belongs to. It is worldwide unique
@@ -61,7 +96,7 @@ export interface SpanContextData {
     /**
      * Only true if the SpanContext was propagated from a remote parent.
      */
-    isRemote?: boolean;
+    isRemote?: boolean | undefined;
     /**
      * Trace flags to propagate.
      *
@@ -69,9 +104,10 @@ export interface SpanContextData {
      * sampled or not. When set, the least significant bit documents that the
      * caller may have recorded trace data. A caller who does not record trace
      * data out-of-band leaves this flag unset.
-     * We allow number here because otel also does, so we can't be stricter than them.
      */
     traceFlags: TraceFlag | number;
+    /** In OpenTelemetry, this can be used to store trace state, which are basically key-value pairs. */
+    traceState?: TraceState | undefined;
 }
 /**
  * Interface holding all properties that can be set on a Span on creation.
@@ -102,13 +138,6 @@ export interface SpanContext {
      * Trace ID
      */
     traceId?: string | undefined;
-    /**
-     * Tags of the Span.
-     * @deprecated Pass `attributes` instead.
-     */
-    tags?: {
-        [key: string]: Primitive;
-    };
     /**
      * Data of the Span.
      * @deprecated Pass `attributes` instead.
@@ -128,10 +157,6 @@ export interface SpanContext {
      * Timestamp in seconds (epoch time) indicating when the span ended.
      */
     endTimestamp?: number | undefined;
-    /**
-     * The origin of the span, giving context about what created the span.
-     */
-    origin?: SpanOrigin | undefined;
 }
 /**
  * A generic Span which holds trace data.
@@ -157,11 +182,9 @@ export interface Span {
      */
     setAttributes(attributes: SpanAttributes): void;
     /**
-     * Sets the status attribute on the current span
-     * See: {@sentry/core SpanStatusType} for possible values
-     * @param status http code used to set the status
+     * Sets the status attribute on the current span.
      */
-    setStatus(status: string): this;
+    setStatus(status: SpanStatus): this;
     /**
      * Update the name of the span.
      */

package/types-ts3.8/spanStatus.d.ts

@@ -0,0 +1,59 @@
+type SpanStatusType = 
+/** The operation completed successfully. */
+'ok'
+/** Deadline expired before operation could complete. */
+ | 'deadline_exceeded'
+/** 401 Unauthorized (actually does mean unauthenticated according to RFC 7235) */
+ | 'unauthenticated'
+/** 403 Forbidden */
+ | 'permission_denied'
+/** 404 Not Found. Some requested entity (file or directory) was not found. */
+ | 'not_found'
+/** 429 Too Many Requests */
+ | 'resource_exhausted'
+/** Client specified an invalid argument. 4xx. */
+ | 'invalid_argument'
+/** 501 Not Implemented */
+ | 'unimplemented'
+/** 503 Service Unavailable */
+ | 'unavailable'
+/** Other/generic 5xx. */
+ | 'internal_error'
+/** Unknown. Any non-standard HTTP status code. */
+ | 'unknown_error'
+/** The operation was cancelled (typically by the user). */
+ | 'cancelled'
+/** Already exists (409) */
+ | 'already_exists'
+/** Operation was rejected because the system is not in a state required for the operation's */
+ | 'failed_precondition'
+/** The operation was aborted, typically due to a concurrency issue. */
+ | 'aborted'
+/** Operation was attempted past the valid range. */
+ | 'out_of_range'
+/** Unrecoverable data loss or corruption */
+ | 'data_loss';
+declare const SPAN_STATUS_UNSET = 0;
+declare const SPAN_STATUS_OK = 1;
+declare const SPAN_STATUS_ERROR = 2;
+/** The status code of a span. */
+export type SpanStatusCode = typeof SPAN_STATUS_UNSET | typeof SPAN_STATUS_OK | typeof SPAN_STATUS_ERROR;
+/**
+ * The status of a span.
+ * This can optionally contain a human-readable message.
+ */
+export interface SpanStatus {
+    /**
+     * The status code of this message.
+     * 0 = UNSET
+     * 1 = OK
+     * 2 = ERROR
+     */
+    code: SpanStatusCode;
+    /**
+     * A developer-facing error message.
+     */
+    message?: SpanStatusType | string;
+}
+export {};
+//# sourceMappingURL=spanStatus.d.ts.map

package/types-ts3.8/stacktrace.d.ts

@@ -7,7 +7,7 @@ export interface Stacktrace {
         number
     ];
 }
-export type StackParser = (stack: string, skipFirst?: number) => StackFrame[];
+export type StackParser = (stack: string, skipFirstLines?: number, framesToPop?: number) => StackFrame[];
 export type StackLineParserFn = (line: string) => StackFrame | undefined;
 export type StackLineParser = [
     number,

package/types-ts3.8/startSpanOptions.d.ts

@@ -1,8 +1,6 @@
-import { Primitive } from './misc';
 import { Scope } from './scope';
-import { SpanAttributes, SpanOrigin, SpanTimeInput } from './span';
-import { TransactionContext, TransactionMetadata, TransactionSource } from './transaction';
-export interface StartSpanOptions extends TransactionContext {
+import { SpanAttributes, SpanTimeInput } from './span';
+export interface StartSpanOptions {
     /** A manually specified start time for the created `Span` object. */
     startTime?: SpanTimeInput;
     /** If defined, start this span off this scope instead off the current scope. */
@@ -19,69 +17,7 @@ export interface StartSpanOptions extends TransactionContext {
      * It is not guaranteed that a span started with this flag set to `true` will be sent as a transaction.
      */
     forceTransaction?: boolean;
-    /**
-     * The origin of the span - if it comes from auto instrumentation or manual instrumentation.
-     *
-     * @deprecated Set `attributes[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]` instead.
-     */
-    origin?: SpanOrigin;
     /** Attributes for the span. */
     attributes?: SpanAttributes;
-    /**
-     * @deprecated Manually set the end timestamp instead.
-     */
-    trimEnd?: boolean;
-    /**
-     * @deprecated This cannot be set manually anymore.
-     */
-    parentSampled?: boolean;
-    /**
-     * @deprecated Use attributes or set data on scopes instead.
-     */
-    metadata?: Partial<TransactionMetadata>;
-    /**
-     * @deprecated Use `span.setStatus()` instead.
-     */
-    status?: string;
-    /**
-     * @deprecated Use `scope` instead.
-     */
-    parentSpanId?: string;
-    /**
-     * @deprecated You cannot manually set the span to sampled anymore.
-     */
-    sampled?: boolean;
-    /**
-     * @deprecated You cannot manually set the spanId anymore.
-     */
-    spanId?: string;
-    /**
-     * @deprecated You cannot manually set the traceId anymore.
-     */
-    traceId?: string;
-    /**
-     * @deprecated Use an attribute instead.
-     */
-    source?: TransactionSource;
-    /**
-     * @deprecated Use attributes or set tags on the scope instead.
-     */
-    tags?: {
-        [key: string]: Primitive;
-    };
-    /**
-     * @deprecated Use attributes instead.
-     */
-    data?: {
-        [key: string]: any;
-    };
-    /**
-     * @deprecated Use `startTime` instead.
-     */
-    startTimestamp?: number;
-    /**
-     * @deprecated Use `span.end()` instead.
-     */
-    endTimestamp?: number;
 }
 //# sourceMappingURL=startSpanOptions.d.ts.map

package/types-ts3.8/transaction.d.ts

@@ -1,7 +1,7 @@
 import { Context } from './context';
 import { DynamicSamplingContext } from './envelope';
 import { MeasurementUnit } from './measurement';
-import { ExtractedNodeRequestData, Primitive, WorkerLocation } from './misc';
+import { ExtractedNodeRequestData, WorkerLocation } from './misc';
 import { PolymorphicRequest } from './polymorphics';
 import { Span, SpanAttributes, SpanContext } from './span';
 /**
@@ -69,13 +69,6 @@ export interface Transaction extends Pick<TransactionContext, Exclude<keyof Tran
      * @inheritDoc
      */
     startTimestamp: number;
-    /**
-     * Tags for the transaction.
-     * @deprecated Use `getSpanAttributes(transaction)` instead.
-     */
-    tags: {
-        [key: string]: Primitive;
-    };
     /**
      * Data for the transaction.
      * @deprecated Use `getSpanAttributes(transaction)` instead.

package/types-ts3.8/transport.d.ts

@@ -19,7 +19,7 @@ export interface BaseTransportOptions extends InternalBaseTransportOptions {
     url: string;
 }
 export interface Transport {
-    send(request: Envelope): PromiseLike<void | TransportMakeRequestResponse>;
+    send(request: Envelope): PromiseLike<TransportMakeRequestResponse>;
     flush(timeout?: number): PromiseLike<boolean>;
 }
 export type TransportRequestExecutor = (request: TransportRequest) => PromiseLike<TransportMakeRequestResponse>;

package/types-ts3.8/user.d.ts

@@ -8,10 +8,4 @@ export interface User {
     email?: string;
     username?: string;
 }
-export interface UserFeedback {
-    event_id: string;
-    email: User['email'];
-    name: string;
-    comments: string;
-}
 //# sourceMappingURL=user.d.ts.map