Files
supabase/apps/studio/data/branches/branch-update-mutation.ts
Ivan Vasilov 8b657165b5 chore: Migrate to use custom type for ReactQuery queries and mutations (#40073)
* Add custom types for queries, mutations and infinite queries.

* Migrate all queries to use the new type.

* Migrate all infinite queries to useCustomInfiniteQueryOptions.

* Migrate all mutations to use useCustomMutationOptions.

* Add type to all imports in `types` folder.
2025-11-03 13:18:13 +01:00

68 lines
1.8 KiB
TypeScript

import { useMutation, useQueryClient } from '@tanstack/react-query'
import { toast } from 'sonner'
import { handleError, patch } from 'data/fetchers'
import type { ResponseError, UseCustomMutationOptions } from 'types'
import { branchKeys } from './keys'
export type BranchUpdateVariables = {
branchRef: string
projectRef: string
branchName?: string
gitBranch?: string
persistent?: boolean
requestReview?: boolean
}
export async function updateBranch({
branchRef,
branchName,
gitBranch,
persistent,
requestReview,
}: BranchUpdateVariables) {
const { data, error } = await patch('/v1/branches/{branch_id_or_ref}', {
params: {
path: { branch_id_or_ref: branchRef },
},
body: {
branch_name: branchName,
git_branch: gitBranch,
persistent,
request_review: requestReview,
},
})
if (error) handleError(error)
return data
}
type BranchUpdateData = Awaited<ReturnType<typeof updateBranch>>
export const useBranchUpdateMutation = ({
onSuccess,
onError,
...options
}: Omit<
UseCustomMutationOptions<BranchUpdateData, ResponseError, BranchUpdateVariables>,
'mutationFn'
> = {}) => {
const queryClient = useQueryClient()
return useMutation<BranchUpdateData, ResponseError, BranchUpdateVariables>({
mutationFn: (vars) => updateBranch(vars),
async onSuccess(data, variables, context) {
const { projectRef } = variables
await queryClient.invalidateQueries({ queryKey: branchKeys.list(projectRef) })
await onSuccess?.(data, variables, context)
},
async onError(data, variables, context) {
if (onError === undefined) {
toast.error(`Failed to update branch: ${data.message}`)
} else {
onError(data, variables, context)
}
},
...options,
})
}