@kentcdodds/sentry

Inspect Sentry organizations, projects, issues, and event summaries.
src/index.ts

47 lines · 1.5 KB · TypeScript
/**
 * Re-exports the public helpers for `kody:@kentcdodds/sentry`.
 *
 * Use this package root entrypoint instead of reaching into internal source files.
 */
export {
  getIssue,
  getIssueEvents,
  getLatestIssueEvent,
  listOrganizations,
  listProjects,
  resolveProject,
  searchIssues,
  searchIssuesPage,
  searchIssuesWithLatestSummaries,
  sentryRequest,
  summarizeIssueEvent,
  triageIssue,
} from './client.ts'

/** Describe the sentry package exports and import pattern. */
export default async function sentryUtilities() {
  return {
    package: '@kentcdodds/sentry',
    description: 'Headless Kody utilities for Sentry issue investigation.',
    utilities: [
      'list-organizations',
      'list-projects',
      'resolve-project',
      'search-issues',
      'list-issues',
      'get-issue',
      'get-latest-issue-event',
      'get-issue-events',
      'summarize-issue-event',
      'triage-issue',
      'request',
    ],
    importPattern: "import utility from 'kody:@kentcdodds/sentry/<utility-name>'",
    paramsNote: 'Kody package entrypoints receive the outer execute params object.',
    consolidatedNotes: {
      'search-issues': 'Use paginated: true for cursor pages; includeLatestSummaries: true for event summaries.',
      'summarize-issue-event': 'Pass issueId (optionally latest: true) to fetch and summarize the latest event.',
      request: 'Escape hatch for paths not covered by the OpenAPI scaffold (e.g. /issues/{id}/events/latest/).',
    },
  }
}