@sentry/types 8.41.0 → 8.43.0

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

@@ -1,222 +0,0 @@
-import { Measurements } from './measurement';
-import { Primitive } from './misc';
-import { HrTime } from './opentelemetry';
-import { SpanStatus } from './spanStatus';
-import { TransactionSource } from './transaction';
-type SpanOriginType = 'manual' | 'auto';
-type SpanOriginCategory = string;
-type SpanOriginIntegrationName = string;
-type SpanOriginIntegrationPart = string;
-export type SpanOrigin = SpanOriginType | string | string | string;
-export type SpanAttributeValue = string | number | boolean | Array<null | undefined | string> | Array<null | undefined | number> | Array<null | undefined | boolean>;
-export type SpanAttributes = Partial<{
-    'sentry.origin': string;
-    'sentry.op': string;
-    'sentry.source': TransactionSource;
-    'sentry.sample_rate': number;
-}> & Record<string, SpanAttributeValue | undefined>;
-export type MetricSummary = {
-    min: number;
-    max: number;
-    count: number;
-    sum: number;
-    tags?: Record<string, Primitive> | undefined;
-};
-/** This type is aligned with the OpenTelemetry TimeInput type. */
-export type SpanTimeInput = HrTime | number | Date;
-/** A JSON representation of a span. */
-export interface SpanJSON {
-    data?: {
-        [key: string]: any;
-    };
-    description?: string;
-    op?: string;
-    parent_span_id?: string;
-    span_id: string;
-    start_timestamp: number;
-    status?: string;
-    timestamp?: number;
-    trace_id: string;
-    origin?: SpanOrigin;
-    _metrics_summary?: Record<string, Array<MetricSummary>>;
-    profile_id?: string;
-    exclusive_time?: number;
-    measurements?: Measurements;
-    is_segment?: boolean;
-    segment_id?: string;
-}
-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
-     * with practically sufficient probability by being made as 16 randomly
-     * generated bytes, encoded as a 32 lowercase hex characters corresponding to
-     * 128 bits.
-     */
-    traceId: string;
-    /**
-     * The ID of the Span. It is globally unique with practically sufficient
-     * probability by being made as 8 randomly generated bytes, encoded as a 16
-     * lowercase hex characters corresponding to 64 bits.
-     */
-    spanId: string;
-    /**
-     * Only true if the SentrySpanArguments was propagated from a remote parent.
-     */
-    isRemote?: boolean | undefined;
-    /**
-     * Trace flags to propagate.
-     *
-     * It is represented as 1 byte (bitmap). Bit to represent whether trace is
-     * 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.
-     */
-    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.
- * This is only used for the legacy span/transaction creation and will go away in v8.
- */
-export interface SentrySpanArguments {
-    /**
-     * Human-readable identifier for the span.
-     */
-    name?: string | undefined;
-    /**
-     * Operation of the Span.
-     */
-    op?: string | undefined;
-    /**
-     * Parent Span ID
-     */
-    parentSpanId?: string | undefined;
-    /**
-     * Was this span chosen to be sent as part of the sample?
-     */
-    sampled?: boolean | undefined;
-    /**
-     * Span ID
-     */
-    spanId?: string | undefined;
-    /**
-     * Trace ID
-     */
-    traceId?: string | undefined;
-    /**
-     * Attributes of the Span.
-     */
-    attributes?: SpanAttributes;
-    /**
-     * Timestamp in seconds (epoch time) indicating when the span started.
-     */
-    startTimestamp?: number | undefined;
-    /**
-     * Timestamp in seconds (epoch time) indicating when the span ended.
-     */
-    endTimestamp?: number | undefined;
-    /**
-     * Set to `true` if this span should be sent as a standalone segment span
-     * as opposed to a transaction.
-     *
-     * @experimental this option is currently experimental and should only be
-     * used within SDK code. It might be removed or changed in the future.
-     */
-    isStandalone?: boolean | undefined;
-}
-/**
- * A generic Span which holds trace data.
- */
-export interface Span {
-    /**
-     * Get context data for this span.
-     * This includes the spanId & the traceId.
-     */
-    spanContext(): SpanContextData;
-    /**
-     * End the current span.
-     */
-    end(endTimestamp?: SpanTimeInput): void;
-    /**
-     * Set a single attribute on the span.
-     * Set it to `undefined` to remove the attribute.
-     */
-    setAttribute(key: string, value: SpanAttributeValue | undefined): this;
-    /**
-     * Set multiple attributes on the span.
-     * Any attribute set to `undefined` will be removed.
-     */
-    setAttributes(attributes: SpanAttributes): this;
-    /**
-     * Sets the status attribute on the current span.
-     */
-    setStatus(status: SpanStatus): this;
-    /**
-     * Update the name of the span.
-     */
-    updateName(name: string): this;
-    /**
-     * If this is span is actually recording data.
-     * This will return false if tracing is disabled, this span was not sampled or if the span is already finished.
-     */
-    isRecording(): boolean;
-    /**
-     * Adds an event to the Span.
-     */
-    addEvent(name: string, attributesOrStartTime?: SpanAttributes | SpanTimeInput, startTime?: SpanTimeInput): this;
-    /**
-     * NOT USED IN SENTRY, only added for compliance with OTEL Span interface
-     */
-    addLink(link: unknown): this;
-    /**
-     * NOT USED IN SENTRY, only added for compliance with OTEL Span interface
-     */
-    addLinks(links: unknown): this;
-    /**
-     * NOT USED IN SENTRY, only added for compliance with OTEL Span interface
-     */
-    recordException(exception: unknown, time?: number): void;
-}
-export {};
-//# sourceMappingURL=span.d.ts.map

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

@@ -1,59 +0,0 @@
-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/build/types-ts3.8/stackframe.d.ts

@@ -1,22 +0,0 @@
-/** JSDoc */
-export interface StackFrame {
-    filename?: string;
-    function?: string;
-    module?: string;
-    platform?: string;
-    lineno?: number;
-    colno?: number;
-    abs_path?: string;
-    context_line?: string;
-    pre_context?: string[];
-    post_context?: string[];
-    in_app?: boolean;
-    instruction_addr?: string;
-    addr_mode?: string;
-    vars?: {
-        [key: string]: any;
-    };
-    debug_id?: string;
-    module_metadata?: any;
-}
-//# sourceMappingURL=stackframe.d.ts.map

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

@@ -1,16 +0,0 @@
-import { StackFrame } from './stackframe';
-/** JSDoc */
-export interface Stacktrace {
-    frames?: StackFrame[];
-    frames_omitted?: [
-        number,
-        number
-    ];
-}
-export type StackParser = (stack: string, skipFirstLines?: number, framesToPop?: number) => StackFrame[];
-export type StackLineParserFn = (line: string) => StackFrame | undefined;
-export type StackLineParser = [
-    number,
-    StackLineParserFn
-];
-//# sourceMappingURL=stacktrace.d.ts.map

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

@@ -1,46 +0,0 @@
-import { Scope } from './scope';
-import { Span, 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. */
-    scope?: Scope;
-    /** The name of the span. */
-    name: string;
-    /** If set to true, only start a span if a parent span exists. */
-    onlyIfParent?: boolean;
-    /** An op for the span. This is a categorization for spans. */
-    op?: string;
-    /**
-     * If provided, make the new span a child of this span.
-     * If this is not provided, the new span will be a child of the currently active span.
-     * If this is set to `null`, the new span will have no parent span.
-     */
-    parentSpan?: Span | null;
-    /**
-     * If set to true, this span will be forced to be treated as a transaction in the Sentry UI, if possible and applicable.
-     * Note that it is up to the SDK to decide how exactly the span will be sent, which may change in future SDK versions.
-     * It is not guaranteed that a span started with this flag set to `true` will be sent as a transaction.
-     */
-    forceTransaction?: boolean;
-    /** Attributes for the span. */
-    attributes?: SpanAttributes;
-    /**
-     * Experimental options without any stability guarantees. Use with caution!
-     */
-    experimental?: {
-        /**
-         * If set to true, always start a standalone span which will be sent as a
-         * standalone segment span envelope instead of a transaction envelope.
-         *
-         * @internal this option is currently experimental and should only be
-         * used within SDK code. It might be removed or changed in the future.
-         * The payload ("envelope") of the resulting request sending the span to
-         * Sentry might change at any time.
-         *
-         * @hidden
-         */
-        standalone?: boolean;
-    };
-}
-//# sourceMappingURL=startSpanOptions.d.ts.map

package/build/types-ts3.8/thread.d.ts

@@ -1,10 +0,0 @@
-import { Stacktrace } from './stacktrace';
-/** JSDoc */
-export interface Thread {
-    id?: number;
-    name?: string;
-    stacktrace?: Stacktrace;
-    crashed?: boolean;
-    current?: boolean;
-}
-//# sourceMappingURL=thread.d.ts.map

package/build/types-ts3.8/timedEvent.d.ts

@@ -1,7 +0,0 @@
-import { SpanAttributes, SpanTimeInput } from './span';
-export interface TimedEvent {
-    name: string;
-    time: SpanTimeInput;
-    attributes?: SpanAttributes;
-}
-//# sourceMappingURL=timedEvent.d.ts.map

package/build/types-ts3.8/tracing.d.ts

@@ -1,51 +0,0 @@
-import { DynamicSamplingContext } from './envelope';
-export type TracePropagationTargets = (string | RegExp)[];
-/**
- * `PropagationContext` represents the data from an incoming trace. It should be constructed from incoming trace data,
- * usually represented by `sentry-trace` and `baggage` HTTP headers.
- *
- * There is always a propagation context present in the SDK (or rather on Scopes), holding at least a `traceId`. This is
- * to ensure that there is always a trace we can attach events onto, even if performance monitoring is disabled. If
- * there was no incoming `traceId`, the `traceId` will be generated by the current SDK.
- */
-export interface PropagationContext {
-    /**
-     * Either represents the incoming `traceId` or the `traceId` generated by the current SDK, if there was no incoming trace.
-     */
-    traceId: string;
-    /**
-     * Represents the execution context of the current SDK. This acts as a fallback value to associate events with a
-     * particular execution context when performance monitoring is disabled.
-     *
-     * The ID of a current span (if one exists) should have precedence over this value when propagating trace data.
-     */
-    spanId: string;
-    /**
-     * Represents the sampling decision of the incoming trace.
-     *
-     * The current SDK should not modify this value!
-     */
-    sampled?: boolean;
-    /**
-     * The `parentSpanId` denotes the ID of the incoming client span. If there is no `parentSpanId` on the propagation
-     * context, it means that the the incoming trace didn't come from a span.
-     *
-     * The current SDK should not modify this value!
-     */
-    parentSpanId?: string;
-    /**
-     * An undefined dsc in the propagation context means that the current SDK invocation is the head of trace and still free to modify and set the DSC for outgoing requests.
-     *
-     * The current SDK should not modify this value!
-     */
-    dsc?: Partial<DynamicSamplingContext>;
-}
-/**
- * An object holding trace data, like span and trace ids, sampling decision, and dynamic sampling context
- * in a serialized form. Both keys are expected to be used as Http headers or Html meta tags.
- */
-export interface SerializedTraceData {
-    'sentry-trace'?: string;
-    baggage?: string;
-}
-//# sourceMappingURL=tracing.d.ts.map

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

@@ -1,35 +0,0 @@
-/**
- * Data pulled from a `sentry-trace` header
- */
-export interface TraceparentData {
-    /**
-     * Trace ID
-     */
-    traceId?: string | undefined;
-    /**
-     * Parent Span ID
-     */
-    parentSpanId?: string | undefined;
-    /**
-     * If this transaction has a parent, the parent's sampling decision
-     */
-    parentSampled?: boolean | undefined;
-}
-/**
- * Contains information about how the name of the transaction was determined. This will be used by the server to decide
- * whether or not to scrub identifiers from the transaction name, or replace the entire name with a placeholder.
- */
-export type TransactionSource = 
-/** User-defined name */
-'custom'
-/** Raw URL, potentially containing identifiers */
- | 'url'
-/** Parametrized URL / route */
- | 'route'
-/** Name of the view handling the request */
- | 'view'
-/** Named after a software component, such as a function or class name. */
- | 'component'
-/** Name of a background task (e.g. a Celery task) */
- | 'task';
-//# sourceMappingURL=transaction.d.ts.map

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

@@ -1,32 +0,0 @@
-import { Client } from './client';
-import { Envelope } from './envelope';
-export type TransportRequest = {
-    body: string | Uint8Array;
-};
-export type TransportMakeRequestResponse = {
-    statusCode?: number;
-    headers?: {
-        [key: string]: string | null;
-        'x-sentry-rate-limits': string | null;
-        'retry-after': string | null;
-    };
-};
-export interface InternalBaseTransportOptions {
-    /**
-     * @ignore
-     * Users should pass the tunnel property via the init/client options.
-     * This is only used by the SDK to pass the tunnel to the transport.
-     */
-    tunnel?: string;
-    bufferSize?: number;
-    recordDroppedEvent: Client['recordDroppedEvent'];
-}
-export interface BaseTransportOptions extends InternalBaseTransportOptions {
-    url: string;
-}
-export interface Transport {
-    send(request: Envelope): PromiseLike<TransportMakeRequestResponse>;
-    flush(timeout?: number): PromiseLike<boolean>;
-}
-export type TransportRequestExecutor = (request: TransportRequest) => PromiseLike<TransportMakeRequestResponse>;
-//# sourceMappingURL=transport.d.ts.map

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

@@ -1,17 +0,0 @@
-/**
- * An interface describing a user of an application or a handled request.
- */
-export interface User {
-    [key: string]: any;
-    id?: string | number;
-    ip_address?: string;
-    email?: string;
-    username?: string;
-    geo?: GeoLocation;
-}
-export interface GeoLocation {
-    country_code?: string;
-    region?: string;
-    city?: string;
-}
-//# sourceMappingURL=user.d.ts.map

package/build/types-ts3.8/view-hierarchy.d.ts

@@ -1,18 +0,0 @@
-export type ViewHierarchyWindow = {
-    alpha: number;
-    height: number;
-    type: string;
-    visible: boolean;
-    width: number;
-    x: number;
-    y: number;
-    z?: number;
-    children?: ViewHierarchyWindow[];
-    depth?: number;
-    identifier?: string;
-} & Record<string, string | number | boolean>;
-export type ViewHierarchyData = {
-    rendering_system: string;
-    windows: ViewHierarchyWindow[];
-};
-//# sourceMappingURL=view-hierarchy.d.ts.map

package/build/types-ts3.8/webfetchapi.d.ts

@@ -1,15 +0,0 @@
-export interface WebFetchHeaders {
-    append(name: string, value: string): void;
-    delete(name: string): void;
-    get(name: string): string | null;
-    has(name: string): boolean;
-    set(name: string, value: string): void;
-    forEach(callbackfn: (value: string, key: string, parent: WebFetchHeaders) => void): void;
-}
-export interface WebFetchRequest {
-    readonly headers: WebFetchHeaders;
-    readonly method: string;
-    readonly url: string;
-    clone(): WebFetchRequest;
-}
-//# sourceMappingURL=webfetchapi.d.ts.map

package/build/types-ts3.8/wrappedfunction.d.ts

@@ -1,7 +0,0 @@
-/** JSDoc */
-export interface WrappedFunction extends Function {
-    [key: string]: any;
-    __sentry_wrapped__?: WrappedFunction;
-    __sentry_original__?: WrappedFunction;
-}
-//# sourceMappingURL=wrappedfunction.d.ts.map