sentry 0.20.0 → 0.21.0

package/dist/index.d.cts

@@ -0,0 +1,652 @@
+export type SentryOptions = {
+  /** Auth token. Auto-filled from SENTRY_AUTH_TOKEN / SENTRY_TOKEN env vars. */
+  token?: string;
+  /** Sentry instance URL for self-hosted. Defaults to sentry.io. */
+  url?: string;
+  /** Default organization slug. */
+  org?: string;
+  /** Default project slug. */
+  project?: string;
+  /** Return human-readable text instead of parsed JSON. */
+  text?: boolean;
+  /** Working directory (affects DSN detection, project root). Defaults to process.cwd(). */
+  cwd?: string;
+};
+
+export declare class SentryError extends Error {
+  readonly exitCode: number;
+  readonly stderr: string;
+  constructor(message: string, exitCode: number, stderr: string);
+}
+
+export declare function createSentrySDK(options?: SentryOptions): SentrySDK & {
+  /** Run an arbitrary CLI command (escape hatch). */
+  run(...args: string[]): Promise<unknown>;
+};
+
+export default createSentrySDK;
+
+// Auto-generated by script/generate-sdk.ts — DO NOT EDIT
+// Run `bun run generate:sdk` to regenerate.
+
+// --- Return types (derived from __jsonSchema) ---
+
+export type RepoListResult = {
+  /** Repository ID */
+  id: string;
+  /** Repository name */
+  name: string;
+  /** Repository URL */
+  url: string | null;
+  /** Version control provider */
+  provider: Record<string, unknown>;
+  /** Integration status */
+  status: string;
+  /** Creation date (ISO 8601) */
+  dateCreated?: string;
+  /** Integration ID */
+  integrationId?: string;
+  /** External slug (e.g. org/repo) */
+  externalSlug?: string | null;
+  /** External ID */
+  externalId?: string | null;
+};
+
+export type TeamListResult = {
+  /** Team ID */
+  id: string;
+  /** Team slug */
+  slug: string;
+  /** Team name */
+  name: string;
+  /** Creation date (ISO 8601) */
+  dateCreated?: string;
+  /** Whether you are a member */
+  isMember?: boolean;
+  /** Your role in the team */
+  teamRole?: string | null;
+  /** Number of members */
+  memberCount?: number;
+};
+
+export type IssueListResult = {
+  /** Numeric issue ID */
+  id: string;
+  /** Human-readable short ID (e.g. PROJ-ABC) */
+  shortId: string;
+  /** Issue title */
+  title: string;
+  /** Culprit string */
+  culprit?: string;
+  /** Total event count */
+  count?: string;
+  /** Number of affected users */
+  userCount?: number;
+  /** First occurrence (ISO 8601) */
+  firstSeen?: string | null;
+  /** Most recent occurrence (ISO 8601) */
+  lastSeen?: string | null;
+  /** Severity level */
+  level?: string;
+  /** Issue status */
+  status?: string;
+  /** Triage priority */
+  priority?: string;
+  /** Platform */
+  platform?: string;
+  /** URL to the issue in Sentry */
+  permalink?: string;
+  /** Project info */
+  project?: Record<string, unknown>;
+  /** Issue metadata */
+  metadata?: Record<string, unknown>;
+  /** Assigned user or team */
+  assignedTo?: unknown | null;
+  /** Issue substatus */
+  substatus?: string | null;
+  /** Whether the issue is unhandled */
+  isUnhandled?: boolean;
+  /** Seer AI fixability score (0-1) */
+  seerFixabilityScore?: number | null;
+};
+
+export type LogListResult = {
+  /** Unique log entry ID */
+  "sentry.item_id": string;
+  /** Log timestamp (ISO 8601) */
+  timestamp: string;
+  /** Nanosecond-precision timestamp */
+  timestamp_precise: number;
+  /** Log message */
+  message?: string | null;
+  /** Severity level (error, warning, info, debug) */
+  severity?: string | null;
+  /** Trace ID for correlation */
+  trace?: string | null;
+};
+
+export type SpanListResult = {
+  /** Span ID */
+  id: string;
+  /** Parent span ID */
+  parent_span?: string | null;
+  /** Span operation (e.g. http.client, db) */
+  "span.op"?: string | null;
+  /** Span description */
+  description?: string | null;
+  /** Duration (ms) */
+  "span.duration"?: number | null;
+  /** Timestamp (ISO 8601) */
+  timestamp: string;
+  /** Project slug */
+  project: string;
+  /** Transaction name */
+  transaction?: string | null;
+  /** Trace ID */
+  trace: string;
+};
+
+export type TraceListResult = {
+  /** Trace ID */
+  trace: string;
+  /** Event ID */
+  id: string;
+  /** Transaction name */
+  transaction: string;
+  /** Timestamp (ISO 8601) */
+  timestamp: string;
+  /** Duration (ms) */
+  "transaction.duration": number;
+  /** Project slug */
+  project: string;
+};
+
+export type TrialListResult = {
+  /** Trial category (e.g. seerUsers, seerAutofix) */
+  category: string;
+  /** Start date (ISO 8601) */
+  startDate: string | null;
+  /** End date (ISO 8601) */
+  endDate: string | null;
+  /** Reason code */
+  reasonCode: number;
+  /** Whether the trial has started */
+  isStarted: boolean;
+  /** Trial duration in days */
+  lengthDays: number | null;
+};
+
+// --- Parameter types ---
+
+export type AuthLoginParams = {
+  /** Authenticate using an API token instead of OAuth */
+  token?: string;
+  /** Timeout for OAuth flow in seconds (default: 900) */
+  timeout?: number;
+  /** Re-authenticate without prompting */
+  force?: boolean;
+};
+
+export type AuthRefreshParams = {
+  /** Force refresh even if token is still valid */
+  force?: boolean;
+};
+
+export type AuthStatusParams = {
+  /** Show the stored token (masked by default) */
+  showToken?: boolean;
+};
+
+export type CliFixParams = {
+  /** Show what would be fixed without making changes */
+  dryRun?: boolean;
+};
+
+export type CliSetupParams = {
+  /** Install the binary from a temp location to the system path */
+  install?: boolean;
+  /** Installation method (curl, npm, pnpm, bun, yarn) */
+  method?: string;
+  /** Release channel to persist (stable or nightly) */
+  channel?: string;
+  /** Skip PATH modification */
+  noModifyPath?: boolean;
+  /** Skip shell completion installation */
+  noCompletions?: boolean;
+  /** Skip agent skill installation for AI coding assistants */
+  noAgentSkills?: boolean;
+  /** Suppress output (for scripted usage) */
+  quiet?: boolean;
+};
+
+export type CliUpgradeParams = {
+  /** Positional argument */
+  version?: string;
+  /** Check for updates without installing */
+  check?: boolean;
+  /** Force upgrade even if already on the latest version */
+  force?: boolean;
+  /** Upgrade using only cached version info and patches (no network) */
+  offline?: boolean;
+  /** Installation method to use (curl, brew, npm, pnpm, bun, yarn) */
+  method?: string;
+};
+
+export type DashboardListParams = {
+  /** Maximum number of dashboards to list */
+  limit?: number;
+  /** Navigate pages: "next", "prev", "first" (or raw cursor string) */
+  cursor?: string;
+};
+
+export type DashboardViewParams = {
+  /** Time period override (e.g., "24h", "7d", "14d") */
+  period?: string;
+};
+
+export type DashboardWidgetAddParams = {
+  /** Display type (big_number, line, area, bar, table, stacked_area, top_n, text, categorical_bar, details, wheel, rage_and_dead_clicks, server_tree, agents_traces_table) */
+  display: string;
+  /** Widget dataset (default: spans) */
+  dataset?: string;
+  /** Aggregate expression (e.g. count, p95:span.duration) */
+  query?: string;
+  /** Search conditions filter (e.g. is:unresolved) */
+  where?: string;
+  /** Group-by column (repeatable) */
+  groupBy?: string;
+  /** Order by (prefix - for desc, e.g. -count) */
+  sort?: string;
+  /** Result limit */
+  limit?: string;
+};
+
+export type DashboardWidgetEditParams = {
+  /** Widget index (0-based) */
+  index?: string;
+  /** Widget title to match */
+  title?: string;
+  /** New widget title */
+  newTitle?: string;
+  /** Display type (big_number, line, area, bar, table, stacked_area, top_n, text, categorical_bar, details, wheel, rage_and_dead_clicks, server_tree, agents_traces_table) */
+  display?: string;
+  /** Widget dataset (default: spans) */
+  dataset?: string;
+  /** Aggregate expression (e.g. count, p95:span.duration) */
+  query?: string;
+  /** Search conditions filter (e.g. is:unresolved) */
+  where?: string;
+  /** Group-by column (repeatable) */
+  groupBy?: string;
+  /** Order by (prefix - for desc, e.g. -count) */
+  sort?: string;
+  /** Result limit */
+  limit?: string;
+};
+
+export type DashboardWidgetDeleteParams = {
+  /** Widget index (0-based) */
+  index?: string;
+  /** Widget title to match */
+  title?: string;
+};
+
+export type OrgListParams = {
+  /** Maximum number of organizations to list */
+  limit?: number;
+};
+
+export type OrgViewParams = {
+  /** Positional argument */
+  org?: string;
+};
+
+export type ProjectCreateParams = {
+  /** Positional argument */
+  namePlatform?: string;
+  /** Team to create the project under */
+  team?: string;
+  /** Validate inputs and show what would be created without creating it */
+  dryRun?: boolean;
+};
+
+export type ProjectDeleteParams = {
+  /** Positional argument */
+  orgProject?: string;
+  /** Skip confirmation prompt */
+  yes?: boolean;
+  /** Force deletion without confirmation */
+  force?: boolean;
+  /** Validate and show what would be deleted without deleting */
+  dryRun?: boolean;
+};
+
+export type ProjectListParams = {
+  /** Positional argument */
+  orgProject?: string;
+  /** Maximum number of projects to list */
+  limit?: number;
+  /** Filter by platform (e.g., javascript, python) */
+  platform?: string;
+  /** Navigate pages: "next", "prev", "first" (or raw cursor string) */
+  cursor?: string;
+};
+
+export type ProjectViewParams = {
+  /** Positional argument */
+  orgProject?: string;
+};
+
+export type RepoListParams = {
+  /** Positional argument */
+  orgProject?: string;
+  /** Maximum number of repositories to list */
+  limit?: number;
+  /** Navigate pages: "next", "prev", "first" (or raw cursor string) */
+  cursor?: string;
+};
+
+export type TeamListParams = {
+  /** Positional argument */
+  orgProject?: string;
+  /** Maximum number of teams to list */
+  limit?: number;
+  /** Navigate pages: "next", "prev", "first" (or raw cursor string) */
+  cursor?: string;
+};
+
+export type IssueListParams = {
+  /** Positional argument */
+  orgProject?: string;
+  /** Search query (Sentry search syntax) */
+  query?: string;
+  /** Maximum number of issues to list */
+  limit?: number;
+  /** Sort by: date, new, freq, user */
+  sort?: string;
+  /** Time period for issue activity (e.g. 24h, 14d, 90d) */
+  period?: string;
+  /** Pagination cursor (use "next" for next page, "prev" for previous) */
+  cursor?: string;
+};
+
+export type IssueExplainParams = {
+  /** Positional argument */
+  issue?: string;
+  /** Force new analysis even if one exists */
+  force?: boolean;
+};
+
+export type IssuePlanParams = {
+  /** Positional argument */
+  issue?: string;
+  /** Root cause ID to plan (required if multiple causes exist) */
+  cause?: string;
+  /** Force new plan even if one exists */
+  force?: boolean;
+};
+
+export type IssueViewParams = {
+  /** Positional argument */
+  issue?: string;
+  /** Span tree depth limit (number, "all" for unlimited, "no" to disable) */
+  spans?: number;
+};
+
+export type EventViewParams = {
+  /** Span tree depth limit (number, "all" for unlimited, "no" to disable) */
+  spans?: number;
+};
+
+export type LogListParams = {
+  /** Number of log entries (1-1000) */
+  limit?: number;
+  /** Filter query (Sentry search syntax) */
+  query?: string;
+  /** Time period (e.g., "30d", "14d", "24h"). Default: 30d (project mode), 14d (trace mode) */
+  period?: string;
+  /** Sort order: "newest" (default) or "oldest" */
+  sort?: string;
+};
+
+export type SourcemapInjectParams = {
+  /** Positional argument */
+  directory?: string;
+  /** Comma-separated file extensions to process (default: .js,.cjs,.mjs) */
+  ext?: string;
+  /** Show what would be modified without writing */
+  dryRun?: boolean;
+};
+
+export type SourcemapUploadParams = {
+  /** Positional argument */
+  directory?: string;
+  /** Release version to associate with the upload */
+  release?: string;
+  /** URL prefix for uploaded files (default: ~/) */
+  urlPrefix?: string;
+};
+
+export type SpanListParams = {
+  /** Number of spans (<=1000) */
+  limit?: number;
+  /** Filter spans (e.g., "op:db", "duration:>100ms", "project:backend") */
+  query?: string;
+  /** Sort order: date, duration */
+  sort?: string;
+  /** Time period (e.g., "1h", "24h", "7d", "30d") */
+  period?: string;
+  /** Navigate pages: "next", "prev", "first" (or raw cursor string) */
+  cursor?: string;
+};
+
+export type SpanViewParams = {
+  /** Span tree depth limit (number, "all" for unlimited, "no" to disable) */
+  spans?: number;
+};
+
+export type TraceListParams = {
+  /** Positional argument */
+  orgProject?: string;
+  /** Number of traces (1-1000) */
+  limit?: number;
+  /** Search query (Sentry search syntax) */
+  query?: string;
+  /** Sort by: date, duration */
+  sort?: string;
+  /** Time period (e.g., "1h", "24h", "7d", "30d") */
+  period?: string;
+  /** Navigate pages: "next", "prev", "first" (or raw cursor string) */
+  cursor?: string;
+};
+
+export type TraceViewParams = {
+  /** Span tree depth limit (number, "all" for unlimited, "no" to disable) */
+  spans?: number;
+};
+
+export type TraceLogsParams = {
+  /** Time period to search (e.g., "14d", "7d", "24h"). Default: 14d */
+  period?: string;
+  /** Number of log entries (<=1000) */
+  limit?: number;
+  /** Additional filter query (Sentry search syntax) */
+  query?: string;
+  /** Sort order: "newest" (default) or "oldest" */
+  sort?: string;
+};
+
+export type TrialListParams = {
+  /** Positional argument */
+  org?: string;
+};
+
+export type TrialStartParams = {
+  /** Positional argument */
+  nameOrg?: string;
+};
+
+export type InitParams = {
+  /** Positional argument */
+  targetDirectory?: string;
+  /** Non-interactive mode (accept defaults) */
+  yes?: boolean;
+  /** Preview changes without applying them */
+  dryRun?: boolean;
+  /** Features to enable: errors,tracing,logs,replay,metrics,profiling,sourcemaps,crons,ai-monitoring,user-feedback */
+  features?: string;
+  /** Team slug to create the project under */
+  team?: string;
+};
+
+export type ApiParams = {
+  /** Positional argument */
+  endpoint?: string;
+  /** The HTTP method for the request */
+  method?: string;
+  /** Inline JSON body for the request (like curl -d) */
+  data?: string;
+  /** Add a typed parameter (key=value, key[sub]=value, key[]=value) */
+  field?: string;
+  /** Add a string parameter without JSON parsing */
+  rawField?: string;
+  /** Add a HTTP request header in key:value format */
+  header?: string;
+  /** The file to use as body for the HTTP request (use "-" to read from standard input) */
+  input?: string;
+  /** Do not print the response body */
+  silent?: boolean;
+  /** Show the resolved request without sending it */
+  dryRun?: boolean;
+};
+
+export type SchemaParams = {
+  /** Show all endpoints in a flat list */
+  all?: boolean;
+  /** Search endpoints by keyword */
+  search?: string;
+};
+
+// --- SDK type ---
+
+export type SentrySDK = {
+    /** Display help for a command */
+    help(...positional: string[]): Promise<unknown>;
+    /** Initialize Sentry in your project (experimental) */
+    init(params?: InitParams): Promise<unknown>;
+    /** Make an authenticated API request */
+    api(params?: ApiParams): Promise<unknown>;
+    /** Browse the Sentry API schema */
+    schema(params?: SchemaParams, ...positional: string[]): Promise<unknown>;
+  auth: {
+        /** Authenticate with Sentry */
+        login(params?: AuthLoginParams): Promise<unknown>;
+        /** Log out of Sentry */
+        logout(): Promise<unknown>;
+        /** Refresh your authentication token */
+        refresh(params?: AuthRefreshParams): Promise<unknown>;
+        /** View authentication status */
+        status(params?: AuthStatusParams): Promise<unknown>;
+        /** Print the stored authentication token */
+        token(): Promise<unknown>;
+        /** Show the currently authenticated user */
+        whoami(): Promise<unknown>;
+  };
+  cli: {
+        /** Send feedback about the CLI */
+        feedback(...positional: string[]): Promise<unknown>;
+        /** Diagnose and repair CLI database issues */
+        fix(params?: CliFixParams): Promise<unknown>;
+        /** Configure shell integration */
+        setup(params?: CliSetupParams): Promise<unknown>;
+        /** Update the Sentry CLI to the latest version */
+        upgrade(params?: CliUpgradeParams): Promise<unknown>;
+  };
+  dashboard: {
+        /** List dashboards */
+        list(params?: DashboardListParams, ...positional: string[]): Promise<unknown>;
+        /** View a dashboard */
+        view(params?: DashboardViewParams, ...positional: string[]): Promise<unknown>;
+        /** Create a dashboard */
+        create(...positional: string[]): Promise<unknown>;
+    widget: {
+            /** Add a widget to a dashboard */
+            add(params: DashboardWidgetAddParams, ...positional: string[]): Promise<unknown>;
+            /** Edit a widget in a dashboard */
+            edit(params?: DashboardWidgetEditParams, ...positional: string[]): Promise<unknown>;
+            /** Delete a widget from a dashboard */
+            delete(params?: DashboardWidgetDeleteParams, ...positional: string[]): Promise<unknown>;
+    };
+  };
+  org: {
+        /** List organizations */
+        list(params?: OrgListParams): Promise<unknown>;
+        /** View details of an organization */
+        view(params?: OrgViewParams): Promise<unknown>;
+  };
+  project: {
+        /** Create a new project */
+        create(params?: ProjectCreateParams): Promise<unknown>;
+        /** Delete a project */
+        delete(params?: ProjectDeleteParams): Promise<unknown>;
+        /** List projects */
+        list(params?: ProjectListParams): Promise<unknown>;
+        /** View details of a project */
+        view(params?: ProjectViewParams): Promise<unknown>;
+  };
+  repo: {
+        /** List repositories */
+        list(params?: RepoListParams): Promise<RepoListResult>;
+  };
+  team: {
+        /** List teams */
+        list(params?: TeamListParams): Promise<TeamListResult>;
+  };
+  issue: {
+        /** List issues in a project */
+        list(params?: IssueListParams): Promise<IssueListResult>;
+        /** Analyze an issue's root cause using Seer AI */
+        explain(params?: IssueExplainParams): Promise<unknown>;
+        /** Generate a solution plan using Seer AI */
+        plan(params?: IssuePlanParams): Promise<unknown>;
+        /** View details of a specific issue */
+        view(params?: IssueViewParams): Promise<unknown>;
+  };
+  event: {
+        /** View details of a specific event */
+        view(params?: EventViewParams, ...positional: string[]): Promise<unknown>;
+  };
+  log: {
+        /** List logs from a project */
+        list(params?: LogListParams, ...positional: string[]): Promise<LogListResult>;
+        /** View details of one or more log entries */
+        view(...positional: string[]): Promise<unknown>;
+  };
+  sourcemap: {
+        /** Inject debug IDs into JavaScript files and sourcemaps */
+        inject(params?: SourcemapInjectParams): Promise<unknown>;
+        /** Upload sourcemaps to Sentry */
+        upload(params?: SourcemapUploadParams): Promise<unknown>;
+  };
+  span: {
+        /** List spans in a project or trace */
+        list(params?: SpanListParams, ...positional: string[]): Promise<SpanListResult>;
+        /** View details of specific spans */
+        view(params?: SpanViewParams, ...positional: string[]): Promise<unknown>;
+  };
+  trace: {
+        /** List recent traces in a project */
+        list(params?: TraceListParams): Promise<TraceListResult>;
+        /** View details of a specific trace */
+        view(params?: TraceViewParams, ...positional: string[]): Promise<unknown>;
+        /** View logs associated with a trace */
+        logs(params?: TraceLogsParams, ...positional: string[]): Promise<unknown>;
+  };
+  trial: {
+        /** List product trials */
+        list(params?: TrialListParams): Promise<TrialListResult>;
+        /** Start a product trial */
+        start(params?: TrialStartParams): Promise<unknown>;
+  };
+};
+