Files
supabase/apps/studio/data/config/project-upgrade-eligibility-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

68 lines
2.6 KiB
TypeScript

import { useQuery } from '@tanstack/react-query'
import { components } from 'api-types'
import { IS_PLATFORM } from 'common'
import { configKeys } from './keys'
import { get, handleError } from '@/data/fetchers'
import { useProjectDetailQuery } from '@/data/projects/project-detail-query'
import { PROJECT_STATUS } from '@/lib/constants/infrastructure'
import type { ResponseError, UseCustomQueryOptions } from '@/types'
export type ProjectUpgradeTargetVersion = { postgres_version: string; release_channel: string }
export type ProjectUpgradeEligibilityVariables = { projectRef?: string }
export type ProjectUpgradeEligibilityResponse =
components['schemas']['ProjectUpgradeEligibilityResponse_Output']
export type ProjectUpgradeEligibilityValidationError =
ProjectUpgradeEligibilityResponse['validation_errors'][number]
export type ProjectUpgradeEligibilityWarning = ProjectUpgradeEligibilityResponse['warnings'][number]
/**
* Fetches upgrade eligibility information for a project.
*
* @param projectRef - The project's reference identifier
* @returns The project upgrade eligibility response, or `undefined` if no data was returned
* @throws Error if `projectRef` is not provided
*/
export async function getProjectUpgradeEligibility(
{ projectRef }: ProjectUpgradeEligibilityVariables,
signal?: AbortSignal
): Promise<ProjectUpgradeEligibilityResponse | undefined> {
if (!projectRef) throw new Error('projectRef is required')
const { data, error } = await get('/v1/projects/{ref}/upgrade/eligibility', {
params: { path: { ref: projectRef } },
signal,
})
if (error) handleError(error)
return data as ProjectUpgradeEligibilityResponse | undefined
}
export type ProjectUpgradeEligibilityData = Awaited<ReturnType<typeof getProjectUpgradeEligibility>>
export type ProjectUpgradeEligibilityError = ResponseError
export const useProjectUpgradeEligibilityQuery = <TData = ProjectUpgradeEligibilityData>(
{ projectRef }: ProjectUpgradeEligibilityVariables,
{
enabled = true,
...options
}: UseCustomQueryOptions<
ProjectUpgradeEligibilityData,
ProjectUpgradeEligibilityError,
TData
> = {}
) => {
const { data: project } = useProjectDetailQuery({ ref: projectRef })
return useQuery<ProjectUpgradeEligibilityData, ProjectUpgradeEligibilityError, TData>({
queryKey: configKeys.upgradeEligibility(projectRef),
queryFn: ({ signal }) => getProjectUpgradeEligibility({ projectRef }, signal),
enabled:
enabled &&
project !== undefined &&
project.status === PROJECT_STATUS.ACTIVE_HEALTHY &&
typeof projectRef !== 'undefined' &&
IS_PLATFORM,
...options,
})
}