Files
supabase/apps/studio/data/organizations/organization-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

55 lines
2.0 KiB
TypeScript

import { QueryClient, useQuery } from '@tanstack/react-query'
import { platformComponents as components } from 'api-types'
import { organizationKeys } from './keys'
import { getManagedByFromOrganizationPartner } from './managed-by-utils'
import { get, handleError } from '@/data/fetchers'
import type { ResponseError, UseCustomQueryOptions } from '@/types'
export type OrganizationVariables = { slug?: string }
export type OrganizationDetail = components['schemas']['OrganizationSlugResponse_Output']
export type OrganizationPlanID = OrganizationDetail['plan']['id']
export function castOrganizationSlugResponseToOrganization(org: OrganizationDetail) {
return {
...org,
billing_email: org.billing_email ?? 'Unknown',
managed_by: getManagedByFromOrganizationPartner(org.billing_partner, org.integration_source),
partner_id: org.slug.startsWith('vercel_') ? org.slug.replace('vercel_', '') : undefined,
}
}
export async function getOrganization({ slug }: OrganizationVariables, signal?: AbortSignal) {
if (!slug) throw new Error('Organization slug is required')
const { data, error } = await get('/platform/organizations/{slug}', {
params: { path: { slug } },
signal,
})
if (error) handleError(error)
return castOrganizationSlugResponseToOrganization(data)
}
export type OrganizationsData = Awaited<ReturnType<typeof getOrganization>>
export type OrganizationsError = ResponseError
export const useOrganizationQuery = <TData = OrganizationsData>(
{ slug }: OrganizationVariables,
{
enabled = true,
...options
}: UseCustomQueryOptions<OrganizationsData, OrganizationsError, TData> = {}
) => {
return useQuery<OrganizationsData, OrganizationsError, TData>({
queryKey: organizationKeys.detail(slug),
queryFn: ({ signal }) => getOrganization({ slug }, signal),
enabled: enabled && typeof slug !== 'undefined',
...options,
staleTime: 30 * 60 * 1000,
})
}
export function invalidateOrganizationsQuery(client: QueryClient) {
return client.invalidateQueries({ queryKey: organizationKeys.list() })
}