mirror of
https://github.com/supabase/supabase.git
synced 2026-10-05 17:35:10 +03:00
Gildas GarciaandAlaister Young
737b8595f2
## 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>
68 lines
2.4 KiB
TypeScript
68 lines
2.4 KiB
TypeScript
import { PermissionAction } from '@supabase/shared-types/out/constants'
|
|
import { useQuery } from '@tanstack/react-query'
|
|
|
|
import { configKeys } from './keys'
|
|
import type { components } from '@/data/api'
|
|
import { get, handleError } from '@/data/fetchers'
|
|
import { useAsyncCheckPermissions } from '@/hooks/misc/useCheckPermissions'
|
|
import type { ResponseError, UseCustomQueryOptions } from '@/types'
|
|
|
|
export type ProjectSettingsVariables = { projectRef?: string }
|
|
|
|
// Manually add the protocol property to the response - specifically just for the local/CLI environment
|
|
type ProjectAppConfig = components['schemas']['ProjectSettingsResponse_Output']['app_config'] & {
|
|
protocol?: string
|
|
}
|
|
export type ProjectSettings = components['schemas']['ProjectSettingsResponse_Output'] & {
|
|
app_config?: ProjectAppConfig
|
|
}
|
|
|
|
export async function getProjectSettings(
|
|
{ projectRef }: ProjectSettingsVariables,
|
|
signal?: AbortSignal,
|
|
headers?: Record<string, string>
|
|
) {
|
|
if (!projectRef) throw new Error('projectRef is required')
|
|
|
|
const { data, error } = await get('/platform/projects/{ref}/settings', {
|
|
params: { path: { ref: projectRef } },
|
|
signal,
|
|
headers,
|
|
})
|
|
|
|
if (error) handleError(error)
|
|
return data as unknown as ProjectSettings
|
|
}
|
|
|
|
type ProjectSettingsData = Awaited<ReturnType<typeof getProjectSettings>>
|
|
type ProjectSettingsError = ResponseError
|
|
|
|
export const useProjectSettingsV2Query = <TData = ProjectSettingsData>(
|
|
{ projectRef }: ProjectSettingsVariables,
|
|
{
|
|
enabled = true,
|
|
...options
|
|
}: UseCustomQueryOptions<ProjectSettingsData, ProjectSettingsError, TData> = {}
|
|
) => {
|
|
// [Joshen] Sync with API perms checking here - shouldReturnApiKeys
|
|
// https://github.com/supabase/platform/blob/develop/api/src/routes/platform/projects/ref/settings.controller.ts#L92
|
|
const { can: canReadAPIKeys } = useAsyncCheckPermissions(
|
|
PermissionAction.TENANT_SQL_ADMIN_WRITE,
|
|
'*'
|
|
)
|
|
|
|
return useQuery<ProjectSettingsData, ProjectSettingsError, TData>({
|
|
queryKey: configKeys.settingsV2(projectRef),
|
|
queryFn: ({ signal }) => getProjectSettings({ projectRef }, signal),
|
|
enabled: enabled && typeof projectRef !== 'undefined',
|
|
refetchInterval: (query) => {
|
|
const data = query.state.data
|
|
const apiKeys = data?.service_api_keys ?? []
|
|
const interval =
|
|
canReadAPIKeys && data?.status !== 'INACTIVE' && apiKeys.length === 0 ? 2000 : 0
|
|
return interval
|
|
},
|
|
...options,
|
|
})
|
|
}
|