mirror of
https://github.com/supabase/supabase.git
synced 2026-10-08 10:55:06 +03:00
CharisandJoshen Lim
957e9fec67
## Summary Stacked on #48813 (1.2: notebook content schema). Part of [FE-4109](https://linear.app/supabase/issue/FE-4109/notebooks-data-model) — see that issue for the rest of the notebooks data-model stack. - Teach `content-remap.ts`'s wire↔domain dispatcher about the `notebook` content type, branding each cell's `sql` per `_tag` via the notebook schemas added in 1.2 (parses through `notebookDomainSchema` on the way in, unbrands per cell on the way out). - Add `{ type: 'notebook'; content: Notebooks.Content }` to the `Content` union in `content-query.ts`, plus a `ContentOfType<T>` helper for narrowing it. - Fix the resulting narrowing fallout at call sites that assumed `Content` only ever meant `sql`/`report`/`log_sql`: two generated-query-param casts, and four report/logs call sites now narrowed via `ContentOfType<'report'>` / `ContentOfType<'log_sql'>`. ## Test plan - [x] `pnpm --filter studio vitest run data/content/` — 35 tests pass, including new notebook coverage in `content-remap.test.ts` (per-cell brand separation, missing-field throw, remap↔unmap round-trip) - [x] `pnpm typecheck` — clean (pre-existing unrelated `ui-patterns` error aside) - [x] `pnpm --filter studio lint` — no new warnings/errors on changed files - [x] `pnpm format` — clean --------- Co-authored-by: Joshen Lim <joshenlimek@gmail.com>
98 lines
2.9 KiB
TypeScript
98 lines
2.9 KiB
TypeScript
import { useQuery } from '@tanstack/react-query'
|
|
import { components } from 'api-types'
|
|
|
|
import { remapSqlContentFields } from './content-remap'
|
|
import { contentKeys } from './keys'
|
|
import { get, handleError } from '@/data/fetchers'
|
|
import type {
|
|
Dashboards,
|
|
LogSqlSnippets,
|
|
Notebooks,
|
|
SqlSnippets,
|
|
UseCustomQueryOptions,
|
|
} from '@/types'
|
|
|
|
// TODO — Charis 2026-08-06
|
|
// Temporary widening until we have API support for notebooks
|
|
export type ContentBase = Omit<
|
|
components['schemas']['GetUserContentResponse']['data'][number],
|
|
'type'
|
|
> & { type: components['schemas']['GetUserContentResponse']['data'][number]['type'] | 'notebook' }
|
|
|
|
export type Content = Omit<ContentBase, 'content' | 'type'> &
|
|
(
|
|
| {
|
|
type: 'sql'
|
|
content: SqlSnippets.Content
|
|
}
|
|
| {
|
|
type: 'report'
|
|
content: Dashboards.Content
|
|
}
|
|
| {
|
|
type: 'log_sql'
|
|
content: LogSqlSnippets.Content
|
|
}
|
|
| {
|
|
type: 'notebook'
|
|
content: Notebooks.Content
|
|
}
|
|
)
|
|
|
|
export type ContentType = Content['type']
|
|
|
|
// Narrows the full Content union down to a single content type — for call sites that already
|
|
// know (from the `type` they queried with) which member they're holding, since useContentQuery
|
|
// et al. don't parameterize their return type by the `type` argument.
|
|
export type ContentOfType<T extends ContentType> = Extract<Content, { type: T }>
|
|
|
|
interface GetContentVariables {
|
|
projectRef?: string
|
|
type: ContentType
|
|
name?: string
|
|
limit?: number
|
|
}
|
|
|
|
export async function getContent(
|
|
{ projectRef, type, name, limit = 10 }: GetContentVariables,
|
|
signal?: AbortSignal,
|
|
headers?: HeadersInit
|
|
) {
|
|
if (typeof projectRef === 'undefined') {
|
|
throw new Error('projectRef is required for getContent')
|
|
}
|
|
|
|
const { data, error } = await get('/platform/projects/{ref}/content', {
|
|
params: {
|
|
path: { ref: projectRef },
|
|
// TODO — Charis 2026-08-06
|
|
// Cast until the generated query param type picks up 'notebook' (see ContentBase above)
|
|
query: { type: type as 'sql' | 'report' | 'log_sql', name, limit: limit.toString() },
|
|
},
|
|
headers,
|
|
signal,
|
|
})
|
|
|
|
if (error) handleError(error)
|
|
|
|
return {
|
|
cursor: data.cursor,
|
|
content: remapSqlContentFields(data.data as unknown as Content[]),
|
|
}
|
|
}
|
|
|
|
export type ContentData = Awaited<ReturnType<typeof getContent>>
|
|
export type ContentError = unknown
|
|
|
|
/** @deprecated Use useContentInfiniteQuery from content-infinite-query instead */
|
|
export const useContentQuery = <TData = ContentData>(
|
|
{ projectRef, type, name, limit }: GetContentVariables,
|
|
{ enabled = true, ...options }: UseCustomQueryOptions<ContentData, ContentError, TData> = {}
|
|
) =>
|
|
useQuery<ContentData, ContentError, TData>({
|
|
queryKey: contentKeys.list(projectRef, { type, name, limit }),
|
|
queryFn: ({ signal }) => getContent({ projectRef, type, name, limit }, signal),
|
|
enabled: enabled && typeof projectRef !== 'undefined',
|
|
...options,
|
|
})
|