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

118 lines
3.5 KiB
TypeScript

import { useMutation, useQueryClient } from '@tanstack/react-query'
import { toast } from 'sonner'
import { organizationKeys } from './keys'
import type { components } from '@/data/api'
import { handleError, patch } from '@/data/fetchers'
import type { ResponseError, UseCustomMutationOptions } from '@/types'
export type OrganizationUpdateVariables = {
slug: string
name?: string
billing_email?: string
additional_billing_emails?: string[]
opt_in_tags?: string[]
}
export async function updateOrganization({
slug,
name,
billing_email,
opt_in_tags,
additional_billing_emails,
}: OrganizationUpdateVariables) {
// @ts-ignore [Joshen] API spec is wrong
const payload: components['schemas']['UpdateOrganizationBody'] = {}
if (name) payload.name = name
if (billing_email) payload.billing_email = billing_email
if (opt_in_tags) payload.opt_in_tags = opt_in_tags as any
if (additional_billing_emails) payload.additional_billing_emails = additional_billing_emails
const { data, error } = await patch('/platform/organizations/{slug}', {
params: { path: { slug } },
body: payload,
})
if (error) handleError(error)
return data
}
type OrganizationUpdateData = Awaited<ReturnType<typeof updateOrganization>>
export const useOrganizationUpdateMutation = ({
onSuccess,
onError,
...options
}: Omit<
UseCustomMutationOptions<OrganizationUpdateData, ResponseError, OrganizationUpdateVariables>,
'mutationFn'
> = {}) => {
const queryClient = useQueryClient()
return useMutation<OrganizationUpdateData, ResponseError, OrganizationUpdateVariables>({
mutationFn: (vars) => updateOrganization(vars),
async onSuccess(data, variables, context) {
queryClient.setQueriesData(
{
queryKey: organizationKeys.list(),
exact: true,
},
(prev: components['schemas']['OrganizationResponse_Output'][] | undefined) => {
if (!prev) return prev
return prev.map((org) => {
if (org.slug !== variables.slug) return org
return {
...org,
name: variables.name || org.name,
billing_email: variables.billing_email || org.billing_email,
opt_in_tags: variables.opt_in_tags || org.opt_in_tags,
}
})
}
)
queryClient.setQueriesData(
{
queryKey: organizationKeys.customerProfile(data.slug),
exact: true,
},
(prev: components['schemas']['CustomerResponse_Output'] | undefined) => {
if (!prev) return prev
return {
...prev,
additional_emails: variables.additional_billing_emails || prev.additional_emails,
}
}
)
queryClient.setQueriesData(
{
queryKey: organizationKeys.detail(data.slug),
exact: true,
},
(prev: components['schemas']['OrganizationSlugResponse_Output'] | undefined) => {
if (!prev) return prev
return {
...prev,
name: variables.name || prev.name,
billing_email: variables.billing_email || prev.billing_email,
opt_in_tags: variables.opt_in_tags || prev.opt_in_tags,
}
}
)
await onSuccess?.(data, variables, context)
},
async onError(data, variables, context) {
if (onError === undefined) {
toast.error(`Failed to update organization: ${data.message}`)
} else {
onError(data, variables, context)
}
},
...options,
})
}