mirror of
https://github.com/supabase/supabase.git
synced 2026-09-06 09:59:03 +08:00
2c53ca4a79
## Context This is pre-requisite work for adding support to managing custom reports from the Assistant. Planning to break this into a number of PRs, briefly - Adding read support for custom reports - Adding write support for custom reports - Adding run support for custom reports - Should be able to infer data from the results then This PR starts with adding support for listing and reading custom reports from the Assistant ## Other changes involved - Updates setting up of the home page report to have better title and description - Swaps the variant of the ToggleGroup in the SQL block for custom reports as the default variant blends into the background color of the PopoverContent ## To test - [ ] Assistant should be able to list custom reports + read its contents <img width="428" height="755" alt="image" src="https://github.com/user-attachments/assets/6a15b660-c0ee-4a06-984c-87eff3943eec" /> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **New Features** - Added AI-assisted tools to list reports and retrieve report details, including chart counts, layouts, configurations, and SQL-backed chart information. - Added clearer empty-state messaging when no snippets are available. - **Improvements** - New homepage reports now use the name “Homepage Report” and include a descriptive project-home summary. - Updated query controls with refreshed visual styling. - Improved content requests to support additional request context. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
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'],
|
|
'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,
|
|
})
|