Files
supabase/apps/studio/data/workflow-runs/workflow-runs-query.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

43 lines
1.2 KiB
TypeScript

import { useQuery } from '@tanstack/react-query'
import { get, handleError } from 'data/fetchers'
import type { ResponseError, UseCustomQueryOptions } from 'types'
import { workflowRunKeys } from './keys'
export type WorkflowRunsVariables = {
projectRef?: string
}
export async function getWorkflowRuns({ projectRef }: WorkflowRunsVariables, signal?: AbortSignal) {
if (!projectRef) throw new Error('projectRef is required')
const { data, error } = await get(`/platform/workflow-runs`, {
params: {
query: {
project_ref: projectRef,
},
},
signal,
})
if (error) handleError(error)
return data
}
export type WorkflowRunsData = Awaited<ReturnType<typeof getWorkflowRuns>>
export type WorkflowRunsError = ResponseError
export const useWorkflowRunsQuery = <TData = WorkflowRunsData>(
{ projectRef }: WorkflowRunsVariables,
{
enabled = true,
...options
}: UseCustomQueryOptions<WorkflowRunsData, WorkflowRunsError, TData> = {}
) =>
useQuery<WorkflowRunsData, WorkflowRunsError, TData>({
queryKey: workflowRunKeys.list(projectRef),
queryFn: ({ signal }) => getWorkflowRuns({ projectRef }, signal),
enabled: enabled && typeof projectRef !== 'undefined',
staleTime: 0,
...options,
})