Files
supabase/apps/studio/data/api-keys/api-key-delete-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

57 lines
1.6 KiB
TypeScript

import { useMutation, useQueryClient } from '@tanstack/react-query'
import { del, handleError } from 'data/fetchers'
import { toast } from 'sonner'
import type { ResponseError, UseCustomMutationOptions } from 'types'
import { apiKeysKeys } from './keys'
export type APIKeyDeleteVariables = {
projectRef?: string
id: string
}
export async function deleteAPIKey(payload: APIKeyDeleteVariables) {
if (!payload.projectRef) throw new Error('projectRef is required')
const { data, error } = await del('/v1/projects/{ref}/api-keys/{id}', {
params: {
path: { ref: payload.projectRef, id: payload.id },
query: { reveal: false },
},
})
if (error) handleError(error)
return data
}
type APIKeyDeleteData = Awaited<ReturnType<typeof deleteAPIKey>>
export const useAPIKeyDeleteMutation = ({
onSuccess,
onError,
...options
}: Omit<
UseCustomMutationOptions<APIKeyDeleteData, ResponseError, APIKeyDeleteVariables>,
'mutationFn'
> = {}) => {
const queryClient = useQueryClient()
return useMutation<APIKeyDeleteData, ResponseError, APIKeyDeleteVariables>({
mutationFn: (vars) => deleteAPIKey(vars),
async onSuccess(data, variables, context) {
const { projectRef } = variables
await queryClient.invalidateQueries({ queryKey: apiKeysKeys.list(projectRef) })
await onSuccess?.(data, variables, context)
},
async onError(data, variables, context) {
if (onError === undefined) {
toast.error(`Failed to delete API key: ${data.message}`)
} else {
onError(data, variables, context)
}
},
...options,
})
}