Files
supabase/apps/studio/data/actions/action-detail-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
1.8 KiB
TypeScript

import { useQuery } from '@tanstack/react-query'
import { components } from 'api-types'
import { actionKeys } from './keys'
import { get, handleError } from '@/data/fetchers'
import type { ResponseError, UseCustomQueryOptions } from '@/types'
type ActionRunVariables = {
projectRef?: string
runId?: string
}
export type ActionRun = components['schemas']['ActionRunResponse_Output'] & {
status?: 'SUCCESS' | 'FAILED' | 'RUNNING'
}
export async function getActionRun(
{ projectRef, runId }: ActionRunVariables,
signal?: AbortSignal
) {
if (!projectRef) throw new Error('projectRef is required')
if (!runId) throw new Error('runId is required')
const { data, error } = await get('/v1/projects/{ref}/actions/{run_id}', {
params: { path: { ref: projectRef, run_id: runId } },
signal,
})
if (error) handleError(error)
const isRunning = data.run_steps.length === 0
const isSuccess = data?.run_steps.every((x) => ['EXITED', 'PAUSED'].includes(x.status))
const isFailed = data?.run_steps.some((x) => x.status === 'DEAD')
return {
...data,
status: isRunning ? 'RUNNING' : isSuccess ? 'SUCCESS' : isFailed ? 'FAILED' : 'RUNNING',
} as ActionRun
}
export type ActionRunData = Awaited<ReturnType<typeof getActionRun>>
export type ActionRunError = ResponseError
export const useActionRunQuery = <TData = ActionRunData>(
{ projectRef, runId }: ActionRunVariables,
{ enabled = true, ...options }: UseCustomQueryOptions<ActionRunData, ActionRunError, TData> = {}
) =>
useQuery<ActionRunData, ActionRunError, TData>({
queryKey: actionKeys.detail(projectRef, runId),
queryFn: ({ signal }) => getActionRun({ projectRef, runId }, signal),
enabled: enabled && typeof projectRef !== 'undefined' && typeof runId !== 'undefined',
staleTime: 0,
...options,
})