mirror of
https://github.com/supabase/supabase.git
synced 2026-10-05 17:35:10 +03:00
Gildas GarciaandAlaister Young
737b8595f2
## 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>
85 lines
3.2 KiB
TypeScript
85 lines
3.2 KiB
TypeScript
import { useQuery } from '@tanstack/react-query'
|
|
import { components } from 'api-types'
|
|
|
|
import type { Content } from './content-query'
|
|
import { remapSqlContentField, remapWireSnippet } from './content-remap'
|
|
import { contentKeys } from './keys'
|
|
import type { SnippetWithContent } from './sql-folders-query'
|
|
import { get, handleError } from '@/data/fetchers'
|
|
import type { ResponseError, UseCustomQueryOptions } from '@/types'
|
|
|
|
export type GetUserContentByIdResponse = Omit<
|
|
components['schemas']['GetUserContentByIdResponse_Output'],
|
|
'content'
|
|
> & {
|
|
content: Content['content']
|
|
}
|
|
|
|
export async function getContentById(
|
|
{ projectRef, id }: { projectRef?: string; id?: string },
|
|
signal?: AbortSignal,
|
|
headers?: HeadersInit
|
|
) {
|
|
if (typeof projectRef === 'undefined') throw new Error('projectRef is required')
|
|
if (typeof id === 'undefined') throw new Error('Content ID is required')
|
|
|
|
const { data, error } = await get('/platform/projects/{ref}/content/item/{id}', {
|
|
params: { path: { ref: projectRef, id } },
|
|
headers,
|
|
signal,
|
|
})
|
|
|
|
if (error) throw handleError(error)
|
|
return remapSqlContentField(data as unknown as GetUserContentByIdResponse)
|
|
}
|
|
|
|
export type ContentIdData = Awaited<ReturnType<typeof getContentById>>
|
|
export type ContentIdError = ResponseError
|
|
|
|
// SQL-editor-specific fetch: the editor only ever loads SQL snippets, so the
|
|
// content body is typed as SQL content and the result is a SnippetWithContent
|
|
// (status 'saved') ready to drop into the store — no narrowing/casting at the
|
|
// call site. Reports etc. keep using the generic getContentById above.
|
|
export async function getSqlSnippetById(
|
|
{ projectRef, id }: { projectRef?: string; id?: string },
|
|
signal?: AbortSignal
|
|
): Promise<SnippetWithContent> {
|
|
if (typeof projectRef === 'undefined') throw new Error('projectRef is required')
|
|
if (typeof id === 'undefined') throw new Error('Content ID is required')
|
|
|
|
const { data, error } = await get('/platform/projects/{ref}/content/item/{id}', {
|
|
params: { path: { ref: projectRef, id } },
|
|
signal,
|
|
})
|
|
|
|
if (error) throw handleError(error)
|
|
return remapWireSnippet(data, 'saved')
|
|
}
|
|
|
|
export type SqlSnippetByIdData = Awaited<ReturnType<typeof getSqlSnippetById>>
|
|
|
|
export const useSqlSnippetByIdQuery = <TData = SqlSnippetByIdData>(
|
|
{ projectRef, id }: { projectRef?: string; id?: string },
|
|
{
|
|
enabled = true,
|
|
...options
|
|
}: UseCustomQueryOptions<SqlSnippetByIdData, ContentIdError, TData> = {}
|
|
) =>
|
|
useQuery<SqlSnippetByIdData, ContentIdError, TData>({
|
|
queryKey: contentKeys.resource(projectRef, id),
|
|
queryFn: ({ signal }) => getSqlSnippetById({ projectRef, id }, signal),
|
|
enabled: enabled && typeof projectRef !== 'undefined' && typeof id !== 'undefined',
|
|
...options,
|
|
})
|
|
|
|
export const useContentIdQuery = <TData = ContentIdData>(
|
|
{ projectRef, id }: { projectRef?: string; id?: string },
|
|
{ enabled = true, ...options }: UseCustomQueryOptions<ContentIdData, ContentIdError, TData> = {}
|
|
) =>
|
|
useQuery<ContentIdData, ContentIdError, TData>({
|
|
queryKey: contentKeys.resource(projectRef, id),
|
|
queryFn: ({ signal }) => getContentById({ projectRef, id }, signal),
|
|
enabled: enabled && typeof projectRef !== 'undefined' && typeof id !== 'undefined',
|
|
...options,
|
|
})
|