@sentry/types 8.41.0 → 8.43.0

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

@@ -1,99 +0,0 @@
-import { Attachment } from './attachment';
-import { Breadcrumb } from './breadcrumb';
-import { Contexts } from './context';
-import { DebugMeta } from './debugMeta';
-import { DynamicSamplingContext } from './envelope';
-import { Exception } from './exception';
-import { Extras } from './extra';
-import { Measurements } from './measurement';
-import { Mechanism } from './mechanism';
-import { Primitive } from './misc';
-import { PolymorphicRequest } from './polymorphics';
-import { RequestEventData } from './request';
-import { CaptureContext, Scope } from './scope';
-import { SdkInfo } from './sdkinfo';
-import { SeverityLevel } from './severity';
-import { MetricSummary, SpanJSON } from './span';
-import { Thread } from './thread';
-import { TransactionSource } from './transaction';
-import { User } from './user';
-/** An event to be sent to Sentry. */
-export interface Event {
-    event_id?: string;
-    message?: string;
-    logentry?: {
-        message?: string;
-        params?: string[];
-    };
-    timestamp?: number;
-    start_timestamp?: number;
-    level?: SeverityLevel;
-    platform?: string;
-    logger?: string;
-    server_name?: string;
-    release?: string;
-    dist?: string;
-    environment?: string;
-    sdk?: SdkInfo;
-    request?: RequestEventData;
-    transaction?: string;
-    modules?: {
-        [key: string]: string;
-    };
-    fingerprint?: string[];
-    exception?: {
-        values?: Exception[];
-    };
-    breadcrumbs?: Breadcrumb[];
-    contexts?: Contexts;
-    tags?: {
-        [key: string]: Primitive;
-    };
-    extra?: Extras;
-    user?: User;
-    type?: EventType;
-    spans?: SpanJSON[];
-    measurements?: Measurements;
-    debug_meta?: DebugMeta;
-    sdkProcessingMetadata?: {
-        [key: string]: unknown;
-    } & {
-        request?: PolymorphicRequest;
-        normalizedRequest?: RequestEventData;
-        dynamicSamplingContext?: Partial<DynamicSamplingContext>;
-        capturedSpanScope?: Scope;
-        capturedSpanIsolationScope?: Scope;
-        spanCountBeforeProcessing?: number;
-    };
-    transaction_info?: {
-        source: TransactionSource;
-    };
-    threads?: {
-        values: Thread[];
-    };
-}
-/**
- * The type of an `Event`.
- * Note that `ErrorEvent`s do not have a type (hence its undefined),
- * while all other events are required to have one.
- */
-export type EventType = 'transaction' | 'profile' | 'replay_event' | 'feedback' | undefined;
-export interface ErrorEvent extends Event {
-    type: undefined;
-}
-export interface TransactionEvent extends Event {
-    type: 'transaction';
-    _metrics_summary?: Record<string, Array<MetricSummary>>;
-}
-/** JSDoc */
-export interface EventHint {
-    event_id?: string;
-    captureContext?: CaptureContext;
-    mechanism?: Partial<Mechanism>;
-    syntheticException?: Error | null;
-    originalException?: unknown;
-    attachments?: Attachment[];
-    data?: any;
-    integrations?: string[];
-}
-//# sourceMappingURL=event.d.ts.map

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

@@ -1,12 +0,0 @@
-import { Event, EventHint } from './event';
-/**
- * Event processors are used to change the event before it will be sent.
- * We strongly advise to make this function sync.
- * Returning a PromiseLike<Event | null> will work just fine, but better be sure that you know what you are doing.
- * Event processing will be deferred until your Promise is resolved.
- */
-export interface EventProcessor {
-    (event: Event, hint: EventHint): PromiseLike<Event | null> | Event | null;
-    id?: string;
-}
-//# sourceMappingURL=eventprocessor.d.ts.map

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

@@ -1,12 +0,0 @@
-import { Mechanism } from './mechanism';
-import { Stacktrace } from './stacktrace';
-/** JSDoc */
-export interface Exception {
-    type?: string;
-    value?: string;
-    mechanism?: Mechanism;
-    module?: string;
-    thread_id?: number;
-    stacktrace?: Stacktrace;
-}
-//# sourceMappingURL=exception.d.ts.map

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

@@ -1,3 +0,0 @@
-export type Extra = unknown;
-export type Extras = Record<string, Extra>;
-//# sourceMappingURL=extra.d.ts.map

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

@@ -1,178 +0,0 @@
-import { Primitive } from '../misc';
-import { FeedbackFormData } from './form';
-import { FeedbackTheme } from './theme';
-/**
- * General feedback configuration
- */
-export interface FeedbackGeneralConfiguration {
-    /**
-     * id to use for the main widget container (this will host the shadow DOM)
-     */
-    id: string;
-    /**
-     * Show the Sentry branding
-     */
-    showBranding: boolean;
-    /**
-     * Auto-inject default Feedback actor button to the DOM when integration is
-     * added.
-     */
-    autoInject: boolean;
-    /**
-     * Should the email field be required?
-     */
-    isEmailRequired: boolean;
-    /**
-     * Should the name field be required?
-     */
-    isNameRequired: boolean;
-    /**
-     * Should the email input field be visible? Note: email will still be collected if set via `Sentry.setUser()`
-     */
-    showEmail: boolean;
-    /**
-     * Should the name input field be visible? Note: name will still be collected if set via `Sentry.setUser()`
-     */
-    showName: boolean;
-    /**
-     * Should the screen shots field be included?
-     * Screen shots cannot be marked as required
-     */
-    enableScreenshot: boolean;
-    /**
-     * Fill in email/name input fields with Sentry user context if it exists.
-     * The value of the email/name keys represent the properties of your user context.
-     */
-    useSentryUser: {
-        email: string;
-        name: string;
-    };
-    /**
-     * Set an object that will be merged sent as tags data with the event.
-     */
-    tags?: {
-        [key: string]: Primitive;
-    };
-    /**
-     * Set a nonce to be passed to the injected <style> tag for enforcing CSP
-     */
-    styleNonce?: string;
-    /**
-     * Set a nonce to be passed to the injected <script> tag for enforcing CSP
-     */
-    scriptNonce?: string;
-}
-/**
- * Theme-related configuration
- */
-export interface FeedbackThemeConfiguration {
-    /**
-     * The colorscheme to use. "system" will choose the scheme based on the user's system settings
-     */
-    colorScheme: 'system' | 'light' | 'dark';
-    /**
-     * Light theme customization, will be merged with default theme values.
-     */
-    themeLight: FeedbackTheme;
-    /**
-     * Dark theme customization, will be merged with default theme values.
-     */
-    themeDark: FeedbackTheme;
-}
-/**
- * All of the different text labels that can be customized
- */
-export interface FeedbackTextConfiguration {
-    /**
-     * The label for the Feedback widget button that opens the dialog
-     */
-    triggerLabel: string;
-    /**
-     * The aria label for the Feedback widget button that opens the dialog
-     */
-    triggerAriaLabel: string;
-    /**
-     * The label for the Feedback form cancel button that closes dialog
-     */
-    cancelButtonLabel: string;
-    /**
-     * The label for the Feedback form submit button that sends feedback
-     */
-    submitButtonLabel: string;
-    /**
-     * The label for the Screenshot editor cancel buttons
-     */
-    confirmButtonLabel: string;
-    /**
-     * The title of the Feedback form
-     */
-    formTitle: string;
-    /**
-     * Label for the email input
-     */
-    emailLabel: string;
-    /**
-     * Placeholder text for Feedback email input
-     */
-    emailPlaceholder: string;
-    /**
-     * Label for the message input
-     */
-    messageLabel: string;
-    /**
-     * Placeholder text for Feedback message input
-     */
-    messagePlaceholder: string;
-    /**
-     * Label for the name input
-     */
-    nameLabel: string;
-    /**
-     * Placeholder text for Feedback name input
-     */
-    namePlaceholder: string;
-    /**
-     * Message after feedback was sent successfully
-     */
-    successMessageText: string;
-    /**
-     * Text which indicates that a field is required
-     */
-    isRequiredLabel: string;
-    /**
-     * The label for the button that adds a screenshot and renders the image editor
-     */
-    addScreenshotButtonLabel: string;
-    /**
-     * The label for the button that removes a screenshot and hides the image editor
-     */
-    removeScreenshotButtonLabel: string;
-}
-/**
- * The public callbacks available for the feedback integration
- */
-export interface FeedbackCallbacks {
-    /**
-     * Callback when form is opened
-     */
-    onFormOpen?: () => void;
-    /**
-     * Callback when form is closed and not submitted
-     */
-    onFormClose?: () => void;
-    /**
-     * Callback when feedback is successfully submitted
-     *
-     * After this you'll see a SuccessMessage on the screen for a moment.
-     */
-    onSubmitSuccess?: (data: FeedbackFormData) => void;
-    /**
-     * Callback when feedback is unsuccessfully submitted
-     */
-    onSubmitError?: (error: Error) => void;
-    /**
-     * Callback when the feedback form is submitted successfully, and the SuccessMessage is complete, or dismissed
-     */
-    onFormSubmitted?: () => void;
-}
-//# sourceMappingURL=config.d.ts.map

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

@@ -1,8 +0,0 @@
-import { Attachment } from '../attachment';
-export type FeedbackFormData = {
-    name: string;
-    email: string;
-    message: string;
-    attachments: Attachment[] | undefined;
-};
-//# sourceMappingURL=form.d.ts.map

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

@@ -1,71 +0,0 @@
-import { Attachment } from '../attachment';
-import { Integration } from '../integration';
-import { FeedbackCallbacks, FeedbackGeneralConfiguration, FeedbackTextConfiguration, FeedbackThemeConfiguration } from './config';
-export { FeedbackFormData } from './form';
-import { FeedbackEvent, SendFeedback, SendFeedbackParams, UserFeedback } from './sendFeedback';
-export { FeedbackEvent, UserFeedback, SendFeedback, SendFeedbackParams };
-/**
- * The integration's internal `options` member where every value should be set
- */
-export interface FeedbackInternalOptions extends FeedbackGeneralConfiguration, FeedbackThemeConfiguration, FeedbackTextConfiguration, FeedbackCallbacks {
-}
-type Hooks = unknown;
-type HTMLElement = unknown;
-type HType = unknown;
-type ShadowRoot = unknown;
-type VNode = unknown;
-type FeedbackDialog = {
-    /**
-     * The HTMLElement that is containing all the form content
-     */
-    el: HTMLElement;
-    /**
-     * Insert the Dialog into the Shadow DOM.
-     *
-     * The Dialog starts in the `closed` state where no inner HTML is rendered.
-     */
-    appendToDom: () => void;
-    /**
-     * Remove the dialog from the Shadow DOM
-     */
-    removeFromDom: () => void;
-    /**
-     * Open/Show the dialog & form inside it
-     */
-    open: () => void;
-    /**
-     * Close/Hide the dialog & form inside it
-     */
-    close: () => void;
-};
-interface FeedbackScreenshotInput {
-    /**
-     * The preact component
-     */
-    input: (props: {
-        onError: (error: Error) => void;
-    }) => VNode;
-    /**
-     * The image/screenshot bytes
-     */
-    value: () => Promise<Attachment | undefined>;
-}
-interface CreateDialogProps {
-    options: FeedbackInternalOptions;
-    screenshotIntegration: FeedbackScreenshotIntegration | undefined;
-    sendFeedback: SendFeedback;
-    shadow: ShadowRoot;
-}
-export interface FeedbackModalIntegration extends Integration {
-    createDialog: (props: CreateDialogProps) => FeedbackDialog;
-}
-interface CreateInputProps {
-    h: HType;
-    hooks: Hooks;
-    dialog: FeedbackDialog;
-    options: FeedbackInternalOptions;
-}
-export interface FeedbackScreenshotIntegration extends Integration {
-    createInput: (props: CreateInputProps) => FeedbackScreenshotInput;
-}
-//# sourceMappingURL=index.d.ts.map

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

@@ -1,49 +0,0 @@
-import { Event, EventHint } from '../event';
-import { Primitive } from '../misc';
-import { User } from '../user';
-/**
- * Crash report feedback object
- */
-export interface UserFeedback {
-    event_id: string;
-    email: User['email'];
-    name: string;
-    comments: string;
-}
-interface FeedbackContext extends Record<string, unknown> {
-    message: string;
-    contact_email?: string;
-    name?: string;
-    replay_id?: string;
-    url?: string;
-    associated_event_id?: string;
-}
-/**
- * NOTE: These types are still considered Alpha and subject to change.
- * @hidden
- */
-export interface FeedbackEvent extends Event {
-    type: 'feedback';
-    contexts: Event['contexts'] & {
-        feedback: FeedbackContext;
-    };
-}
-export interface SendFeedbackParams {
-    message: string;
-    name?: string;
-    email?: string;
-    url?: string;
-    source?: string;
-    associatedEventId?: string;
-    /**
-     * Set an object that will be merged sent as tags data with the event.
-     */
-    tags?: {
-        [key: string]: Primitive;
-    };
-}
-export type SendFeedback = (params: SendFeedbackParams, hint?: EventHint & {
-    includeReplay?: boolean;
-}) => Promise<string>;
-export {};
-//# sourceMappingURL=sendFeedback.d.ts.map

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

@@ -1,35 +0,0 @@
-export interface FeedbackTheme {
-    /**
-     * Foreground color (i.e. text color)
-     */
-    foreground?: string;
-    /**
-     * Background color for surfaces
-     */
-    background?: string;
-    /**
-     * Foreground color for accented elements
-     */
-    accentForeground?: string;
-    /**
-     * Background color for accented elements
-     */
-    accentBackground?: string;
-    /**
-     * Success color
-     */
-    successColor?: string;
-    /**
-     * Error color
-     */
-    errorColor?: string;
-    /**
-     * Box shadow for floating elements
-     */
-    boxShadow?: string;
-    /**
-     * Styles for focused interactive components
-     */
-    outline?: string;
-}
-//# sourceMappingURL=theme.d.ts.map

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

@@ -1,195 +0,0 @@
-import { Breadcrumb, BreadcrumbHint } from './breadcrumb';
-import { Client } from './client';
-import { Event, EventHint } from './event';
-import { Extra, Extras } from './extra';
-import { Integration, IntegrationClass } from './integration';
-import { Primitive } from './misc';
-import { Scope } from './scope';
-import { Session } from './session';
-import { SeverityLevel } from './severity';
-import { User } from './user';
-/**
- * Internal class used to make sure we always have the latest internal functions
- * 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)
- *
- */
-export interface Hub {
-    /**
-     * This binds the given client to the current scope.
-     * @param client An SDK client (client) instance.
-     *
-     * @deprecated Use `initAndBind()` directly.
-     */
-    bindClient(client?: Client): void;
-    /**
-     * Creates a new scope with and executes the given operation within.
-     * The scope is automatically removed once the operation
-     * finishes or throws.
-     *
-     * This is essentially a convenience function for:
-     *
-     *     pushScope();
-     *     callback();
-     *     popScope();
-     *
-     * @param callback that will be enclosed into push/popScope.
-     *
-     * @deprecated Use `Sentry.withScope()` instead.
-     */
-    withScope<T>(callback: (scope: Scope) => T): T;
-    /**
-     * Returns the client of the top stack.
-     * @deprecated Use `Sentry.getClient()` instead.
-     */
-    getClient<C extends Client>(): C | undefined;
-    /**
-     * Returns the scope of the top stack.
-     * @deprecated Use `Sentry.getCurrentScope()` instead.
-     */
-    getScope(): Scope;
-    /**
-     * Get the currently active isolation scope.
-     * The isolation scope is used to isolate data between different hubs.
-     *
-     * @deprecated Use `Sentry.getIsolationScope()` instead.
-     */
-    getIsolationScope(): Scope;
-    /**
-     * Captures an exception event and sends it to Sentry.
-     *
-     * @param exception An exception-like object.
-     * @param hint May contain additional information about the original exception.
-     * @returns The generated eventId.
-     *
-     * @deprecated Use `Sentry.captureException()` instead.
-     */
-    captureException(exception: any, hint?: EventHint): string;
-    /**
-     * Captures a message event and sends it to Sentry.
-     *
-     * @param message The message to send to Sentry.
-     * @param level Define the level of the message.
-     * @param hint May contain additional information about the original exception.
-     * @returns The generated eventId.
-     *
-     * @deprecated Use `Sentry.captureMessage()` instead.
-     */
-    captureMessage(message: string, level?: SeverityLevel, hint?: EventHint): string;
-    /**
-     * Captures a manually created event and sends it to Sentry.
-     *
-     * @param event The event to send to Sentry.
-     * @param hint May contain additional information about the original exception.
-     *
-     * @deprecated Use `Sentry.captureEvent()` instead.
-     */
-    captureEvent(event: Event, hint?: EventHint): string;
-    /**
-     * Records a new breadcrumb which will be attached to future events.
-     *
-     * Breadcrumbs will be added to subsequent events to provide more context on
-     * user's actions prior to an error or crash.
-     *
-     * @param breadcrumb The breadcrumb to record.
-     * @param hint May contain additional information about the original breadcrumb.
-     *
-     * @deprecated Use `Sentry.addBreadcrumb()` instead.
-     */
-    addBreadcrumb(breadcrumb: Breadcrumb, hint?: BreadcrumbHint): void;
-    /**
-     * 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.
-     *
-     * @deprecated Use `Sentry.setUser()` instead.
-     */
-    setUser(user: User | null): void;
-    /**
-     * Set an object that will be merged sent as tags data with the event.
-     *
-     * @param tags Tags context object to merge into current context.
-     *
-     * @deprecated Use `Sentry.setTags()` instead.
-     */
-    setTags(tags: {
-        [key: string]: Primitive;
-    }): void;
-    /**
-     * 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
-     *
-     * @deprecated Use `Sentry.setTag()` instead.
-     */
-    setTag(key: string, value: Primitive): void;
-    /**
-     * 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.
-     *
-     * @deprecated Use `Sentry.setExtra()` instead.
-     */
-    setExtra(key: string, extra: Extra): void;
-    /**
-     * Set an object that will be merged sent as extra data with the event.
-     * @param extras Extras object to merge into current context.
-     *
-     * @deprecated Use `Sentry.setExtras()` instead.
-     */
-    setExtras(extras: Extras): void;
-    /**
-     * Sets context data with the given name.
-     * @param name of the context
-     * @param context Any kind of data. This data will be normalized.
-     *
-     * @deprecated Use `Sentry.setContext()` instead.
-     */
-    setContext(name: string, context: {
-        [key: string]: any;
-    } | null): void;
-    /**
-     * Returns the integration if installed on the current client.
-     *
-     * @deprecated Use `Sentry.getClient().getIntegration()` instead.
-     */
-    getIntegration<T extends Integration>(integration: IntegrationClass<T>): T | null;
-    /**
-     * Starts a new `Session`, sets on the current scope and returns it.
-     *
-     * To finish a `session`, it has to be passed directly to `client.captureSession`, which is done automatically
-     * when using `hub.endSession()` for the session currently stored on the scope.
-     *
-     * When there's already an existing session on the scope, it'll be automatically ended.
-     *
-     * @param context Optional properties of the new `Session`.
-     *
-     * @returns The session which was just started
-     *
-     * @deprecated Use top-level `startSession` instead.
-     */
-    startSession(context?: Session): Session;
-    /**
-     * Ends the session that lives on the current scope and sends it to Sentry
-     *
-     * @deprecated Use top-level `endSession` instead.
-     */
-    endSession(): void;
-    /**
-     * Sends the current session on the scope to Sentry
-     *
-     * @param endSession If set the session will be marked as exited and removed from the scope
-     *
-     * @deprecated Use top-level `captureSession` instead.
-     */
-    captureSession(endSession?: boolean): void;
-}
-//# sourceMappingURL=hub.d.ts.map