Files
supabase/apps/studio/data/oauth-server-apps/oauth-server-apps-query.ts
Gildas GarciaandAlaister Young 737b8595f2 Update API types (#50234)
## Problem

platform, v1 and v2 have been already completely migrated and introduced
some changes.

Some types have been renamed, some outputs and inputs updated.

## Solution

- Update the API types
- Fix the TS errors

## Update

Taking this over to unblock #50134, which needs the new scoped token
permission ids from the regenerated types.

- Merged `master`.
- Regenerated `api-v2.d.ts` from the production spec. The previous files
came from a local API that exposed a webhook events endpoint production
doesn't have yet. Production has since added standardized 400 error
responses on the v2 organization endpoints. `api-v1.d.ts` and
`platform.d.ts` already matched production.
- Fixed `verify-production-types`. It formatted the regenerated files in
a temp directory outside the repository, so Prettier fell back to its
defaults and the comparison could never match the committed files. It
now passes the repository config explicitly. `pnpm api:verify-types`
passes on this branch.
- Verified locally: `pnpm typecheck`, `pnpm api:verify-types`, Studio
unit tests.

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **Bug Fixes**
* Preserved descriptions when saving, sharing, moving, or unsharing
notebooks, reports, SQL snippets, and saved queries.
* Improved handling of empty or null values across notebook
descriptions, billing usage, pooler settings, and infrastructure fields.
* Improved read-replica connection handling, including read-only
connection strings.
* Updated storage configuration and capability handling to match current
settings.

* **API and Compatibility**
* Updated organization, project, storage, OAuth, billing, and
infrastructure data handling to match current API responses.
  * OAuth app creation and updates now require scopes.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Alaister Young <10985857+alaister@users.noreply.github.com>
2026-09-11 12:17:49 +08:00

65 lines
2.2 KiB
TypeScript

import { useQuery } from '@tanstack/react-query'
import { components } from 'api-types'
import { oauthServerAppKeys } from './keys'
import { useAuthConfigQuery } from '@/data/auth/auth-config-query'
import { useProjectApiUrl } from '@/data/config/project-endpoint-query'
import { handleError } from '@/data/fetchers'
import { createProjectSupabaseClient } from '@/lib/project-supabase-client'
import type { ResponseError, UseCustomQueryOptions } from '@/types'
export type OAuthServerAppsVariables = {
projectRef: string | undefined
page?: number
}
const APPS_PER_PAGE = 100
export type OAuthApp = components['schemas']['OAuthAppResponse_Output']
export async function getOAuthServerApps({
projectRef,
clientEndpoint,
page = 1,
}: OAuthServerAppsVariables & { clientEndpoint: string | undefined }) {
if (!projectRef) throw new Error('Project reference is required')
if (!clientEndpoint) throw new Error('Client endpoint is required')
const supabaseClient = await createProjectSupabaseClient(projectRef, clientEndpoint)
const { data, error } = await supabaseClient.auth.admin.oauth.listClients({
page,
perPage: APPS_PER_PAGE,
})
if (error) handleError(error)
return data
}
export type OAuthServerAppsData = Awaited<ReturnType<typeof getOAuthServerApps>>
export type OAuthServerAppsError = ResponseError
export const useOAuthServerAppsQuery = <TData = OAuthServerAppsData>(
{ projectRef }: OAuthServerAppsVariables,
{
enabled = true,
...options
}: UseCustomQueryOptions<OAuthServerAppsData, OAuthServerAppsError, TData> = {}
) => {
const { hostEndpoint: clientEndpoint } = useProjectApiUrl({ projectRef })
const { data: authConfig, isSuccess: isSuccessConfig } = useAuthConfigQuery({ projectRef })
const isOAuthServerEnabled = !!authConfig?.OAUTH_SERVER_ENABLED
return useQuery<OAuthServerAppsData, OAuthServerAppsError, TData>({
queryKey: oauthServerAppKeys.list(projectRef, clientEndpoint),
queryFn: () => getOAuthServerApps({ projectRef, clientEndpoint }),
enabled:
enabled &&
typeof projectRef !== 'undefined' &&
!!clientEndpoint &&
isSuccessConfig &&
isOAuthServerEnabled,
...options,
})
}