ref(tsc): refactor self-contained endpoints that need response headers to apiOptions

[TkDodo]

as discussed in last week’s TSC, we need to start moving endpoints over to apiOptions so that we can re-use caches.

the quickest win would be to implement useApiQuery with apiOptions internally, and to get there, we need to migrate endpoints that now need getResponseHeader over to apiOptions because those headers are exposed differently.

this PR takes the first couple of endpoints that are (mostly) self-contained (no other usages of the url found) and moves them over.

I’ve also exposed selectJsonWithHeaders because the default impl only selects json without headers.

I plan to tackle the other occurrences with an endpoint-by-endpoint approach, as we need to identify all places where an endpoint is used (e.g. invalidateQueries or getApiQueryData or setApiQueryData) and migrate them together.

[TkDodo]

note: inline functions run on every render and perform structualSharing on every render. giving a stable identity makes sure we can avoid that and hit the internal queryObserver cache instead.

[TkDodo]

we get type inference here for existingData which is a huge win

[cursor]

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Bugbot Autofix prepared a fix for the issue found in the latest run.

• ✅ Fixed: Error handling narrowed to only catch RequestError
  • Added isError check from useQuery to catch all error types, with instanceof narrowing inside for type-safe access to RequestError properties.

Or push these changes by commenting:

@cursor push 4536c1d9d5

Preview (4536c1d9d5)

diff --git a/static/app/views/alerts/rules/issue/details/issuesList.tsx b/static/app/views/alerts/rules/issue/details/issuesList.tsx
--- a/static/app/views/alerts/rules/issue/details/issuesList.tsx
+++ b/static/app/views/alerts/rules/issue/details/issuesList.tsx
@@ -46,7 +46,7 @@
   cursor,
 }: Props) {
   const organization = useOrganization();
-  const {data, isPending, error} = useQuery({
+  const {data, isPending, isError, error} = useQuery({
     ...apiOptions.as<GroupHistory[]>()(
       '/projects/$organizationIdOrSlug/$projectIdOrSlug/rules/$ruleId/group-history/',
       {
@@ -70,10 +70,14 @@
   });
   const groupHistory = data?.json;
 
-  if (error instanceof RequestError) {
+  if (isError) {
     return (
       <LoadingError
-        message={(error.responseJSON?.detail as string) ?? t('default message')}
+        message={
+          error instanceof RequestError
+            ? ((error.responseJSON?.detail as string) ?? t('default message'))
+            : t('default message')
+        }
       />
     );
   }

_{This Bugbot Autofix run was free. To enable autofix for future PRs, go to the Cursor dashboard.}

^{Reviewed by Cursor Bugbot for commit e79ffcc. Configure here.}

[nsdeschenes]

🚀 🌔