getsentry / getsentry/sentry-react-native
Review and clean up public API surface types
- Lenguaje dominante
- TypeScript
- Estrellas
- 1.8k
- Forks
- 366
- Merge medio
- 1 d 6 h
- PR fusionados (30 d)
- 94
Descripción
## Context
With the addition of `@microsoft/api-extractor` in #6093, we now have visibility into the public API surface. The tool reports 36 `ae-forgotten-export` warnings — types that appear in public function signatures but are not exported from `index.ts`.
None of these types are documented in the Sentry docs, and no users have reported needing them. TypeScript's structural typing means consumers can pass plain object literals without importing the types explicitly.
## What needs reviewing
For each type, decide whether to **export it** (make it part of the public API) or **mark it `@internal`** (explicitly keep it private).
### Options/config types (used as integration/function parameters)
- `ReactNativeTracingOptions`, `ReactNativeTracingState`, `ReactNativeTracingIntegration`
- `ReactNavigationIntegrationOptions`, `ReactNativeNavigationOptions`
- `ReactNativeClientOptions`, `ReactNativeTransportOptions`, `BaseReactNativeOptions`, `ReactNativeWrapperOptions`
- `ReactNativeErrorHandlersOptions`, `LinkedErrorsOptions`, `BreadcrumbsOptions`
- `MobileReplayOptions`, `MobileReplayIntegration`
- `HermesProfilingOptions`
- `GraphQLReactNativeIntegrationOptions`, `SpotlightReactNativeIntegrationOptions`, `SupabaseReactNativeIntegrationOptions`
- `FeedbackFormProps`, `FeedbackButtonProps`, `ScreenshotButtonProps`, `FeedbackFormTheme`
- `TouchEventBoundaryProps`
- `AppStartIntegration`, `defaultIdleOptions`
### Internal/external types (likely should stay unexported)
- `FeedbackFormState`, `FeedbackIntegration`, `GlobalErrorBoundaryState` — internal component state
- `Replay`, `ReplayConfiguration` — `@sentry/browser` internals
- `HostComponent`, `ViewProps` — react-native types
- `ExpoAssetInstance`, `ExpoImageSource`, `ExpoImageLoadOptions`, `ExpoImageRef` — internal Expo types
## Additional items to review
- `logger` from `@sentry/browser` is exported publicly — is this intentional?
Guía de contribución
Línea de trabajo
Comienza con las exportaciones públicas de index.ts y el informe de @microsoft/api-extractor introducido en #6093. Revisa cada tipo de exportación olvidado incluido en la lista y decide si pertenece a la API pública o si debe marcarse con @internal, incluido determinar si la exportación de logger es intencionada. Se considera terminado cuando las 36 advertencias tienen una resolución explícita y la superficie de la API refleja esas decisiones.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- react-native, typescript
- Área
- api, mobile
- Tipo de issue
- Refactorización
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Tranquilo
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100