@sentry/types 8.41.0 → 8.43.0

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

@@ -1,8 +0,0 @@
-/** JSDoc */
-export interface Package {
-    name: string;
-    version: string;
-    dependencies?: Record<string, string>;
-    devDependencies?: Record<string, string>;
-}
-//# sourceMappingURL=package.d.ts.map

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

@@ -1,5 +0,0 @@
-export type ParameterizedString = string & {
-    __sentry_template_string__?: string;
-    __sentry_template_values__?: string[];
-};
-//# sourceMappingURL=parameterize.d.ts.map

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

@@ -1,71 +0,0 @@
-/**
- * Event-like interface that's usable in browser and node.
- *
- * Note: Here we mean the kind of events handled by event listeners, not our `Event` type.
- *
- * Property availability taken from https://developer.mozilla.org/en-US/docs/Web/API/Event#browser_compatibility
- */
-export interface PolymorphicEvent {
-    [key: string]: unknown;
-    readonly type: string;
-    readonly target?: unknown;
-    readonly currentTarget?: unknown;
-}
-/** A `Request` type compatible with Node, Express, browser, etc., because everything is optional */
-export type PolymorphicRequest = BaseRequest & BrowserRequest & NodeRequest & ExpressRequest & KoaRequest & NextjsRequest;
-type BaseRequest = {
-    method?: string;
-    url?: string;
-};
-type BrowserRequest = BaseRequest;
-type NodeRequest = BaseRequest & {
-    headers?: {
-        [key: string]: string | string[] | undefined;
-    };
-    protocol?: string;
-    socket?: {
-        encrypted?: boolean;
-        remoteAddress?: string;
-    };
-};
-type KoaRequest = NodeRequest & {
-    host?: string;
-    hostname?: string;
-    ip?: string;
-    originalUrl?: string;
-};
-type NextjsRequest = NodeRequest & {
-    cookies?: {
-        [key: string]: string;
-    };
-    query?: {
-        [key: string]: any;
-    };
-};
-type ExpressRequest = NodeRequest & {
-    baseUrl?: string;
-    body?: string | {
-        [key: string]: any;
-    };
-    host?: string;
-    hostname?: string;
-    ip?: string;
-    originalUrl?: string;
-    route?: {
-        path: string;
-        stack: [
-            {
-                name: string;
-            }
-        ];
-    };
-    query?: {
-        [key: string]: any;
-    };
-    user?: {
-        [key: string]: any;
-    };
-    _reconstructedRoute?: string;
-};
-export {};
-//# sourceMappingURL=polymorphics.d.ts.map

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

@@ -1,143 +0,0 @@
-import { Client } from './client';
-import { DebugImage } from './debugMeta';
-import { Integration } from './integration';
-import { MeasurementUnit } from './measurement';
-export interface ContinuousProfiler<T extends Client> {
-    initialize(client: T): void;
-    start(): void;
-    stop(): void;
-}
-export interface ProfilingIntegration<T extends Client> extends Integration {
-    _profiler: ContinuousProfiler<T>;
-}
-export interface Profiler {
-    startProfiler(): void;
-    stopProfiler(): void;
-}
-export type ThreadId = string;
-export type FrameId = number;
-export type StackId = number;
-export interface ThreadCpuSample {
-    stack_id: StackId;
-    thread_id: ThreadId;
-    queue_address?: string;
-    elapsed_since_start_ns: string;
-}
-export interface ContinuousThreadCpuSample {
-    stack_id: StackId;
-    thread_id: ThreadId;
-    queue_address?: string;
-    timestamp: number;
-}
-export type ThreadCpuStack = FrameId[];
-export type ThreadCpuFrame = {
-    function?: string;
-    file?: string;
-    lineno?: number;
-    colno?: number;
-    abs_path?: string;
-    platform?: string;
-    instruction_addr?: string;
-    module?: string;
-    in_app?: boolean;
-};
-export interface ThreadCpuProfile {
-    samples: ThreadCpuSample[];
-    stacks: ThreadCpuStack[];
-    frames: ThreadCpuFrame[];
-    thread_metadata: Record<ThreadId, {
-        name?: string;
-        priority?: number;
-    }>;
-    queue_metadata?: Record<string, {
-        label: string;
-    }>;
-}
-export interface ContinuousThreadCpuProfile {
-    samples: ContinuousThreadCpuSample[];
-    stacks: ThreadCpuStack[];
-    frames: ThreadCpuFrame[];
-    thread_metadata: Record<ThreadId, {
-        name?: string;
-        priority?: number;
-    }>;
-    queue_metadata?: Record<string, {
-        label: string;
-    }>;
-}
-interface BaseProfile<T> {
-    version: string;
-    release: string;
-    environment: string;
-    platform: string;
-    profile: T;
-    debug_meta?: {
-        images: DebugImage[];
-    };
-    measurements?: Record<string, {
-        unit: MeasurementUnit;
-        values: {
-            elapsed_since_start_ns: number;
-            value: number;
-        }[];
-    }>;
-}
-export interface Profile extends BaseProfile<ThreadCpuProfile> {
-    event_id: string;
-    version: string;
-    os: {
-        name: string;
-        version: string;
-        build_number?: string;
-    };
-    runtime: {
-        name: string;
-        version: string;
-    };
-    device: {
-        architecture: string;
-        is_emulator: boolean;
-        locale: string;
-        manufacturer: string;
-        model: string;
-    };
-    timestamp: string;
-    release: string;
-    environment: string;
-    platform: string;
-    profile: ThreadCpuProfile;
-    debug_meta?: {
-        images: DebugImage[];
-    };
-    transaction?: {
-        name: string;
-        id: string;
-        trace_id: string;
-        active_thread_id: string;
-    };
-    transactions?: {
-        name: string;
-        id: string;
-        trace_id: string;
-        active_thread_id: string;
-        relative_start_ns: string;
-        relative_end_ns: string;
-    }[];
-    measurements?: Record<string, {
-        unit: MeasurementUnit;
-        values: {
-            elapsed_since_start_ns: number;
-            value: number;
-        }[];
-    }>;
-}
-export interface ProfileChunk extends BaseProfile<ContinuousThreadCpuProfile> {
-    chunk_id: string;
-    profiler_id: string;
-    client_sdk: {
-        name: string;
-        version: string;
-    };
-}
-export {};
-//# sourceMappingURL=profiling.d.ts.map

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

@@ -1,25 +0,0 @@
-import { Event } from './event';
-/**
- * NOTE: These types are still considered Beta and subject to change.
- * @hidden
- */
-export interface ReplayEvent extends Event {
-    urls: string[];
-    replay_start_timestamp?: number;
-    error_ids: string[];
-    trace_ids: string[];
-    replay_id: string;
-    segment_id: number;
-    replay_type: ReplayRecordingMode;
-}
-/**
- * NOTE: These types are still considered Beta and subject to change.
- * @hidden
- */
-export type ReplayRecordingData = string | Uint8Array;
-/**
- * NOTE: These types are still considered Beta and subject to change.
- * @hidden
- */
-export type ReplayRecordingMode = 'session' | 'buffer';
-//# sourceMappingURL=replay.d.ts.map

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

@@ -1,41 +0,0 @@
-/**
- * Request data included in an event as sent to Sentry.
- */
-export interface RequestEventData {
-    url?: string;
-    method?: string;
-    data?: any;
-    query_string?: QueryParams;
-    cookies?: {
-        [key: string]: string;
-    };
-    env?: {
-        [key: string]: string;
-    };
-    headers?: {
-        [key: string]: string;
-    };
-}
-/**
- * Request data included in an event as sent to Sentry.
- * @deprecated: This type will be removed in v9. Use `RequestEventData` instead.
- */
-export type Request = RequestEventData;
-export type QueryParams = string | {
-    [key: string]: string;
-} | Array<[
-    string,
-    string
-]>;
-/**
- * Request data that is considered safe for `span.data` on `http.client` spans
- * and for `http` breadcrumbs
- * See https://develop.sentry.dev/sdk/data-handling/#structuring-data
- */
-export type SanitizedRequestData = {
-    url: string;
-    'http.method': string;
-    'http.fragment'?: string;
-    'http.query'?: string;
-};
-//# sourceMappingURL=request.d.ts.map

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

@@ -1,6 +0,0 @@
-/** Runtime Context. */
-export interface Runtime {
-    name?: string;
-    version?: string;
-}
-//# sourceMappingURL=runtime.d.ts.map

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

@@ -1,41 +0,0 @@
-import { ExtractedNodeRequestData, WorkerLocation } from './misc';
-import { SpanAttributes } from './span';
-/**
- * Context data passed by the user when starting a transaction, to be used by the tracesSampler method.
- */
-export interface CustomSamplingContext {
-    [key: string]: any;
-}
-/**
- * Data passed to the `tracesSampler` function, which forms the basis for whatever decisions it might make.
- *
- * Adds default data to data provided by the user. See {@link Hub.startTransaction}
- */
-export interface SamplingContext extends CustomSamplingContext {
-    /**
-     * Context data with which transaction being sampled was created.
-     * @deprecated This is duplicate data and will be removed eventually.
-     */
-    transactionContext: {
-        name: string;
-        parentSampled?: boolean | undefined;
-    };
-    /**
-     * Sampling decision from the parent transaction, if any.
-     */
-    parentSampled?: boolean;
-    /**
-     * Object representing the URL of the current page or worker script. Passed by default when using the `BrowserTracing`
-     * integration.
-     */
-    location?: WorkerLocation;
-    /**
-     * Object representing the incoming request to a node server. Passed by default when using the TracingHandler.
-     */
-    request?: ExtractedNodeRequestData;
-    /** The name of the span being sampled. */
-    name: string;
-    /** Initial attributes that have been passed to the span being sampled. */
-    attributes?: SpanAttributes;
-}
-//# sourceMappingURL=samplingcontext.d.ts.map

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

@@ -1,241 +0,0 @@
-import { Attachment } from './attachment';
-import { Breadcrumb } from './breadcrumb';
-import { Client } from './client';
-import { Context, Contexts } from './context';
-import { Event, EventHint } from './event';
-import { EventProcessor } from './eventprocessor';
-import { Extra, Extras } from './extra';
-import { Primitive } from './misc';
-import { RequestSession, Session } from './session';
-import { SeverityLevel } from './severity';
-import { Span } from './span';
-import { PropagationContext } from './tracing';
-import { User } from './user';
-/** JSDocs */
-export type CaptureContext = Scope | Partial<ScopeContext> | ((scope: Scope) => Scope);
-/** JSDocs */
-export interface ScopeContext {
-    user: User;
-    level: SeverityLevel;
-    extra: Extras;
-    contexts: Contexts;
-    tags: {
-        [key: string]: Primitive;
-    };
-    fingerprint: string[];
-    requestSession: RequestSession;
-    propagationContext: PropagationContext;
-}
-export interface ScopeData {
-    eventProcessors: EventProcessor[];
-    breadcrumbs: Breadcrumb[];
-    user: User;
-    tags: {
-        [key: string]: Primitive;
-    };
-    extra: Extras;
-    contexts: Contexts;
-    attachments: Attachment[];
-    propagationContext: PropagationContext;
-    sdkProcessingMetadata: {
-        [key: string]: unknown;
-    };
-    fingerprint: string[];
-    level?: SeverityLevel;
-    transactionName?: string;
-    span?: Span;
-}
-/**
- * Holds additional event information.
- */
-export interface Scope {
-    /**
-     * Update the client on the scope.
-     */
-    setClient(client: Client | undefined): void;
-    /**
-     * Get the client assigned to this 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;
-    /**
-     * Sets the last event id on the scope.
-     * @param lastEventId The last event id of a captured event.
-     */
-    setLastEventId(lastEventId: string | undefined): void;
-    /**
-     * This is the getter for lastEventId.
-     * @returns The last event id of a captured event.
-     */
-    lastEventId(): string | 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. */
-    getScopeData(): ScopeData;
-    /**
-     * Updates user context information for future events.
-     *
-     * @param user User context object to be set in the current context. Pass `null` to unset the user.
-     */
-    setUser(user: User | null): this;
-    /**
-     * Returns the `User` if there is one
-     */
-    getUser(): User | undefined;
-    /**
-     * Set an object that will be merged sent as tags data with the event.
-     * @param tags Tags context object to merge into current context.
-     */
-    setTags(tags: {
-        [key: string]: Primitive;
-    }): this;
-    /**
-     * Set key:value that will be sent as tags data with the event.
-     *
-     * Can also be used to unset a tag by passing `undefined`.
-     *
-     * @param key String key of tag
-     * @param value Value of tag
-     */
-    setTag(key: string, value: Primitive): this;
-    /**
-     * Set an object that will be merged sent as extra data with the event.
-     * @param extras Extras object to merge into current context.
-     */
-    setExtras(extras: Extras): this;
-    /**
-     * Set key:value that will be sent as extra data with the event.
-     * @param key String of extra
-     * @param extra Any kind of data. This data will be normalized.
-     */
-    setExtra(key: string, extra: Extra): this;
-    /**
-     * Sets the fingerprint on the scope to send with the events.
-     * @param fingerprint string[] to group events in Sentry.
-     */
-    setFingerprint(fingerprint: string[]): this;
-    /**
-     * Sets the level on the scope for future events.
-     * @param level string {@link SeverityLevel}
-     */
-    setLevel(level: SeverityLevel): this;
-    /**
-     * 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;
-    /**
-     * Sets context data with the given name.
-     * @param name of the context
-     * @param context an object containing context data. This data will be normalized. Pass `null` to unset the context.
-     */
-    setContext(name: string, context: Context | null): this;
-    /**
-     * Returns the `Session` if there is one
-     */
-    getSession(): Session | undefined;
-    /**
-     * Sets the `Session` on the scope
-     */
-    setSession(session?: Session): this;
-    /**
-     * Returns the `RequestSession` if there is one
-     */
-    getRequestSession(): RequestSession | undefined;
-    /**
-     * Sets the `RequestSession` on the scope
-     */
-    setRequestSession(requestSession?: RequestSession): this;
-    /**
-     * Updates the scope with provided data. Can work in three variations:
-     * - plain object containing updatable attributes
-     * - Scope instance that'll extract the attributes from
-     * - callback function that'll receive the current scope as an argument and allow for modifications
-     * @param captureContext scope modifier to be used
-     */
-    update(captureContext?: CaptureContext): this;
-    /** Clears the current scope and resets its properties. */
-    clear(): this;
-    /**
-     * Adds a breadcrumb to the scope
-     * @param breadcrumb Breadcrumb
-     * @param maxBreadcrumbs number of max breadcrumbs to merged into event.
-     */
-    addBreadcrumb(breadcrumb: Breadcrumb, maxBreadcrumbs?: number): this;
-    /**
-     * Get the last breadcrumb.
-     */
-    getLastBreadcrumb(): Breadcrumb | undefined;
-    /**
-     * Clears all breadcrumbs from the scope.
-     */
-    clearBreadcrumbs(): this;
-    /**
-     * Adds an attachment to the scope
-     * @param attachment Attachment options
-     */
-    addAttachment(attachment: Attachment): this;
-    /**
-     * Clears attachments from the scope
-     */
-    clearAttachments(): this;
-    /**
-     * Add data which will be accessible during event processing but won't get sent to Sentry.
-     *
-     * TODO(v9): We should type this stricter, so that e.g. `normalizedRequest` is strictly typed.
-     */
-    setSDKProcessingMetadata(newData: {
-        [key: string]: unknown;
-    }): this;
-    /**
-     * Add propagation context to the scope, used for distributed tracing
-     */
-    setPropagationContext(context: PropagationContext): this;
-    /**
-     * Get propagation context from the scope, used for distributed tracing
-     */
-    getPropagationContext(): PropagationContext;
-    /**
-     * Capture an exception for this scope.
-     *
-     * @param exception The exception to capture.
-     * @param hint Optional additional data to attach to the Sentry event.
-     * @returns the id of the captured Sentry event.
-     */
-    captureException(exception: unknown, hint?: EventHint): string;
-    /**
-     * Capture a message for this scope.
-     *
-     * @param message The message to capture.
-     * @param level An optional severity level to report the message with.
-     * @param hint Optional additional data to attach to the Sentry event.
-     * @returns the id of the captured message.
-     */
-    captureMessage(message: string, level?: SeverityLevel, hint?: EventHint): string;
-    /**
-     * Capture a Sentry event for this scope.
-     *
-     * @param event The event to capture.
-     * @param hint Optional additional data to attach to the Sentry event.
-     * @returns the id of the captured event.
-     */
-    captureEvent(event: Event, hint?: EventHint): string;
-    /**
-     * Clone all data from this scope into a new scope.
-     */
-    clone(): Scope;
-}
-//# sourceMappingURL=scope.d.ts.map

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

@@ -1,8 +0,0 @@
-import { Package } from './package';
-export interface SdkInfo {
-    name?: string;
-    version?: string;
-    integrations?: string[];
-    packages?: Package[];
-}
-//# sourceMappingURL=sdkinfo.d.ts.map

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

@@ -1,5 +0,0 @@
-import { SdkInfo } from './sdkinfo';
-export interface SdkMetadata {
-    sdk?: SdkInfo;
-}
-//# sourceMappingURL=sdkmetadata.d.ts.map

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

@@ -1,75 +0,0 @@
-import { User } from './user';
-export interface RequestSession {
-    status?: RequestSessionStatus;
-}
-export interface Session {
-    sid: string;
-    did?: string | number;
-    init: boolean;
-    timestamp: number;
-    started: number;
-    duration?: number;
-    status: SessionStatus;
-    release?: string;
-    environment?: string;
-    userAgent?: string;
-    ipAddress?: string;
-    errors: number;
-    user?: User | null;
-    ignoreDuration: boolean;
-    abnormal_mechanism?: string;
-    /**
-     * Overrides default JSON serialization of the Session because
-     * the Sentry servers expect a slightly different schema of a session
-     * which is described in the interface @see SerializedSession in this file.
-     *
-     * @return a Sentry-backend conforming JSON object of the session
-     */
-    toJSON(): SerializedSession;
-}
-export type SessionContext = Partial<Session>;
-export type SessionStatus = 'ok' | 'exited' | 'crashed' | 'abnormal';
-export type RequestSessionStatus = 'ok' | 'errored' | 'crashed';
-/** JSDoc */
-export interface SessionAggregates {
-    attrs?: {
-        environment?: string;
-        release?: string;
-    };
-    aggregates: Array<AggregationCounts>;
-}
-export interface SessionFlusherLike {
-    /**
-     * Increments the Session Status bucket in SessionAggregates Object corresponding to the status of the session
-     * captured
-     */
-    incrementSessionStatusCount(): void;
-    /** Empties Aggregate Buckets and Sends them to Transport Buffer */
-    flush(): void;
-    /** Clears setInterval and calls flush */
-    close(): void;
-}
-export interface AggregationCounts {
-    started: string;
-    errored?: number;
-    exited?: number;
-    crashed?: number;
-}
-export interface SerializedSession {
-    init: boolean;
-    sid: string;
-    did?: string;
-    timestamp: string;
-    started: string;
-    duration?: number;
-    status: SessionStatus;
-    errors: number;
-    abnormal_mechanism?: string;
-    attrs?: {
-        release?: string;
-        environment?: string;
-        user_agent?: string;
-        ip_address?: string;
-    };
-}
-//# sourceMappingURL=session.d.ts.map

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

@@ -1,2 +0,0 @@
-export type SeverityLevel = 'fatal' | 'error' | 'warning' | 'log' | 'info' | 'debug';
-//# sourceMappingURL=severity.d.ts.map